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

Fix documentation #773

Merged
merged 5 commits into from
Jan 16, 2025
Merged

Fix documentation #773

merged 5 commits into from
Jan 16, 2025

Conversation

jeremykubica
Copy link
Contributor

The file structure for the KBMOD API documentation has gotten very out of data, including references to files that no longer exist and not including many of recent files. This PR brings it more up to date.

It also fixes some docstring formatting that was causing warnings.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Collaborator

@drewoldag drewoldag left a comment

Choose a reason for hiding this comment

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

Only one minor comment, otherwise looks pretty good to me.

src/kbmod/analysis/plotting.py Show resolved Hide resolved
@jeremykubica jeremykubica merged commit 9c5f738 into main Jan 16, 2025
2 checks passed
@jeremykubica jeremykubica deleted the doc_fixes branch January 16, 2025 22:29
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