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

Improve doc and enable more functions in API doc #1149

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

lee1043
Copy link
Contributor

@lee1043 lee1043 commented Sep 26, 2024

improve docstrings, enable some functions from working branch to enable their early usage, included them in api reference docs -- requires v3.6.1 release to be used.

…le their early usage, included them in api reference docs
@lee1043 lee1043 added the doc label Sep 26, 2024
@lee1043 lee1043 self-assigned this Sep 26, 2024
@lee1043 lee1043 requested a review from acordonez September 26, 2024 20:13
@lee1043
Copy link
Contributor Author

lee1043 commented Sep 26, 2024

@acordonez I checked this installs well on my end, but could you also check the same on your end too? I added a few more functions to API docs that is helpful for @gleckler1's obs4MIPs work, but that means we need to release new minor version update (v3.6.1) to make the docs consistent with what actually existing functions. Once this PR merges, I will work on releasing a new version.

@acordonez
Copy link
Collaborator

@lee1043 Yes I'll give this a test today

Copy link
Collaborator

@acordonez acordonez left a comment

Choose a reason for hiding this comment

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

I installed this new branch successfully. I also tested all of the api import statements in ipython after installation and found no issues with importation (for example, from pcmdi_metrics.utils import create_land_sea_mask).

@lee1043
Copy link
Contributor Author

lee1043 commented Sep 26, 2024

@acordonez excellent, thank you for testing it promptly!

@lee1043 lee1043 merged commit 66fc459 into main Sep 26, 2024
4 checks passed
@lee1043 lee1043 deleted the lee1043_improve_docstrings_20240926 branch September 26, 2024 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants