Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

discard documentation cleanup #72

Merged
merged 7 commits into from
Sep 16, 2024
Merged

discard documentation cleanup #72

merged 7 commits into from
Sep 16, 2024

Conversation

andybeet
Copy link
Member

@andybeet andybeet commented Sep 16, 2024

Move files

  • Moved internal functions from exports and removed documentation, noRd
  • Moved old functions not used anymore in comlandr to another folder

Data docs

  • Added documentation for lazy loaded data
    * mskeyAreas
    * mskeyGears
    * soeAreas
    * deflate

Cleaned docs

  • Updated getting started page to reflect use of ROracle and changes in package structure
  • Cleaned up documenation and argument lists for files several files
  • Updated DESCRIPTION file and package file comlandr to update slucey info

@andybeet andybeet requested a review from sgaichas September 16, 2024 13:22
@andybeet
Copy link
Member Author

@sgaichas can you build the site locally to make sure it looks ok?

@sgaichas
Copy link
Member

I got an error building on the container; see below....

I can't build at all on my laptop due to the ROracle dependency (just spent over an hour trying to install instantclient and build ROracle to no avail, so can't install dbutils either).

-- Building home ---------------------------------------------------------------
Writing 'authors.html'
Reading 'news.md'
Writing 'news.html'
Writing 'LICENSE-text.html'
Writing '404.html'
-- Building function reference -------------------------------------------------
Error: 
! in callr subprocess.
Caused by error in `map2(.x, vec_index(.x), .f, ...)`:
! i In index: 2.
Caused by error in `purrr::map()`:
i In index: 1.
Caused by error:
! In '_pkgdown.yml', topic must be a known topic name or alias
x Not 'comlandr'
i See `$stdout` for standard output.
Type .Last.error to see the more details.

@andybeet
Copy link
Member Author

yeah ok, i'm going to push a fix (that you still wont be able to test!!) then pull these changes in myself.

- install instructions
- package metadata
@sgaichas sgaichas merged commit 722c729 into dev Sep 16, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants