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

Closes #1987 - Updates AutoAPI Documentation #2148

Merged
merged 7 commits into from
Feb 22, 2023

Conversation

Ethan-DeBandi99
Copy link
Contributor

Closes #1987

  • Updates files to include client facing functions in __all__ to ensure they are documented. Files where everything is client facing do not require __all__.
  • Updates some helper functions to prefix with _. This does not include all that exist, but this will be an ongoing process.
  • Updates formatting of DocStrings to ensure that they render properly in GitHub pages.
  • Removes files that do not contain any client facing code from being included in the AutoAPI documentation creation.
    • arkouda/message.py
    • arkouda/_version.py
    • arkouda/decorators.py
  • Updates pydoc/conf.py to set autoapi_options to ['members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members', ] as opposed to using the default. This removes private-members and special-members. This prevents private functions (_func_name) from being included in the AutoAPI docs. It also prevents functions like __len__() from being rendered in the AutoAPI.

This PR does not address missing DocStrings. A separate issue will be put in to update missing DocStrings.

Copy link
Contributor

@jaketrookman jaketrookman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style changes look good

Copy link
Member

@stress-tess stress-tess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Well done running on this down!

I saw a couple of small things but I imagine we're gonna find a lot of them over the next few months

arkouda/io.py Outdated Show resolved Hide resolved
arkouda/io.py Outdated Show resolved Hide resolved
arkouda/groupbyclass.py Show resolved Hide resolved
arkouda/pdarraysetops.py Show resolved Hide resolved
arkouda/segarray.py Show resolved Hide resolved
arkouda/strings.py Show resolved Hide resolved
@stress-tess stress-tess added this pull request to the merge queue Feb 22, 2023
Merged via the queue into Bears-R-Us:master with commit cd3cbd1 Feb 22, 2023
@Ethan-DeBandi99 Ethan-DeBandi99 deleted the 1987_autoapi_fixes branch February 22, 2023 19:34
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.

Review autoapi Documentation Configuration
4 participants