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

python: add flux.job.list docstrings #5500

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

wihobbs
Copy link
Member

@wihobbs wihobbs commented Oct 12, 2023

This doesn't fully document the job.list module but I think it's a good start.

Copy link
Contributor

@grondo grondo left a comment

Choose a reason for hiding this comment

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

Thanks for doing this. A few comments and corrections inline.

src/bindings/python/flux/job/list.py Outdated Show resolved Hide resolved
src/bindings/python/flux/job/list.py Outdated Show resolved Hide resolved
src/bindings/python/flux/job/list.py Outdated Show resolved Hide resolved
@jameshcorbett
Copy link
Member

Can you add a commit body? I think

Problem: some flux.job.list functions are missing docstrings.

Add them.

Would do it.

@wihobbs wihobbs force-pushed the job_list_id-docstrings branch from 8fba3dc to ad77d95 Compare October 13, 2023 00:09
@wihobbs
Copy link
Member Author

wihobbs commented Oct 13, 2023

Thanks guys, I think I got all your corrections.

@wihobbs wihobbs force-pushed the job_list_id-docstrings branch 6 times, most recently from bb632c8 to d256cb8 Compare October 13, 2023 20:33
Copy link
Member

@jameshcorbett jameshcorbett left a comment

Choose a reason for hiding this comment

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

LGTM but you dropped the commit body :/

@wihobbs wihobbs force-pushed the job_list_id-docstrings branch from d256cb8 to b8f9ebf Compare October 13, 2023 21:56
Copy link
Member

@jameshcorbett jameshcorbett left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @wihobbs !

Problem: Some flux.job.list functions are undocumented.

Solution: Add docstrings.
@wihobbs wihobbs force-pushed the job_list_id-docstrings branch from b8f9ebf to 3e8fd51 Compare October 14, 2023 20:41
@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

Merging #5500 (3e8fd51) into master (c26f97f) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5500      +/-   ##
==========================================
+ Coverage   83.67%   83.70%   +0.02%     
==========================================
  Files         484      484              
  Lines       81537    81537              
==========================================
+ Hits        68228    68250      +22     
+ Misses      13309    13287      -22     
Files Coverage Δ
src/bindings/python/flux/job/list.py 96.77% <ø> (ø)

... and 12 files with indirect coverage changes

@jameshcorbett
Copy link
Member

Ok to set MWP @grondo @wihobbs ?

@jameshcorbett
Copy link
Member

Checked with Hobbs, setting MWP.

@mergify mergify bot merged commit 313f2e2 into flux-framework:master Oct 16, 2023
32 checks passed
@wihobbs wihobbs deleted the job_list_id-docstrings branch January 12, 2024 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants