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

Docs and version #38

Merged
merged 1 commit into from
Sep 29, 2023
Merged

Docs and version #38

merged 1 commit into from
Sep 29, 2023

Conversation

SkBlaz
Copy link
Collaborator

@SkBlaz SkBlaz commented Sep 28, 2023

Updated docs + version bump + pip released.

Copy link
Collaborator

@miha-jenko miha-jenko left a comment

Choose a reason for hiding this comment

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

The general docs are a bit messy, every public function / method and global variable is rendered. Consider limiting this list. The pdoc documentation suggests using __all__ to limit what is public. But there are probably other mechanisms to ignore and limit the scope of documented names.

@SkBlaz
Copy link
Collaborator Author

SkBlaz commented Sep 28, 2023

The general docs are a bit messy, every public function / method and global variable is rendered. Consider limiting this list. The pdoc documentation suggests using __all__ to limit what is public. But there are probably other mechanisms to ignore and limit the scope of documented names.

Good point, thanks @miha-jenko. Indeed, the purpose of this PR was merely to align source/signatures; perhaps we should consider refactoring of the docs themselves in a separate PR? Currently everything is searchable which was the first milestone, it can be done better for sure.

@SkBlaz SkBlaz merged commit 97e7adf into main Sep 29, 2023
5 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.

6 participants