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

[R][Documentation] Create documentation for undocumented methods and args in filesystem.R #35601

Closed
amoeba opened this issue May 15, 2023 · 2 comments · Fixed by #35895
Closed

Comments

@amoeba
Copy link
Member

amoeba commented May 15, 2023

Describe the bug, including details regarding any error messages, version, and platform.

The manual page for ?FileSystem is missing some methods such as $ls() so it would be good to go over that page to document anything that's missing. We don't use roxygen2's R6 functionality due to reasons outlined in #23127 which is why it's possible for the docs for R6 classes to get out of sync. This also means other R6 classes in other files may need a review once filesystem.R is updated.

Component(s)

Documentation, R

@amoeba
Copy link
Member Author

amoeba commented May 16, 2023

take

@amoeba
Copy link
Member Author

amoeba commented Jun 3, 2023

I looked at all of the R6 classes in filesystem.R and looked for missing docs in methods, active bindings, and $create functions. I found:

  • S3FileSystem$create is missing a docstring for proxy_options
  • GcsFileSystem was missing docs for the active binding options , which I missed in [R] Expose GcsFileSystem options in R #34422
  • FileSystem was missing docs for methods path, cd, and ls

Edit: I opted not to document clone and print since they're inherited but would document them if nudged.

paleolimbot pushed a commit that referenced this issue Jun 7, 2023
### What changes are included in this PR?

Just new docstrings to cover missing ones.

### Are these changes tested?

I built the package locally and previewed the new help pages.

### Are there any user-facing changes?

No

* Closes: #35601

Authored-by: Bryce Mecum <petridish@gmail.com>
Signed-off-by: Dewey Dunnington <dewey@fishandwhistle.net>
@paleolimbot paleolimbot added this to the 13.0.0 milestone Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants