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

Remove TODOs from docstrings #2773

Merged
merged 18 commits into from
Sep 11, 2021
Merged

Remove TODOs from docstrings #2773

merged 18 commits into from
Sep 11, 2021

Conversation

nodeg
Copy link
Member

@nodeg nodeg commented Aug 31, 2021

In preparation of the 3.3.0 release, this will remove the TODOs from the property docstrings with actual values.

@nodeg nodeg added documentation Improvements or additions to documentation main Not a release but referring to the Git main branch labels Aug 31, 2021
@nodeg nodeg added this to the v3.3.0 milestone Aug 31, 2021
@nodeg nodeg added this to Pull Requests in V3.3.0 via automation Aug 31, 2021
@codecov
Copy link

codecov bot commented Aug 31, 2021

Codecov Report

Merging #2773 (1bfdf8f) into master (af118f5) will decrease coverage by 0.01%.
The diff coverage is 92.30%.

❗ Current head 1bfdf8f differs from pull request most recent head 0fd777c. Consider uploading reports for the commit 0fd777c to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2773      +/-   ##
==========================================
- Coverage   43.12%   43.10%   -0.02%     
==========================================
  Files          97       97              
  Lines       14079    14082       +3     
==========================================
- Hits         6071     6070       -1     
- Misses       8008     8012       +4     
Impacted Files Coverage Δ
cobbler/items/file.py 67.50% <ø> (ø)
cobbler/items/menu.py 65.15% <ø> (ø)
cobbler/items/package.py 89.47% <ø> (ø)
cobbler/items/profile.py 83.78% <ø> (ø)
cobbler/items/repo.py 83.41% <ø> (ø)
cobbler/items/resource.py 89.33% <ø> (ø)
cobbler/items/system.py 76.06% <ø> (ø)
cobbler/items/image.py 77.61% <75.00%> (ø)
cobbler/items/distro.py 87.21% <100.00%> (+0.11%) ⬆️
cobbler/items/item.py 79.44% <100.00%> (+0.05%) ⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af118f5...0fd777c. Read the comment docs.

@SchoolGuy SchoolGuy self-requested a review September 10, 2021 07:50
@SchoolGuy SchoolGuy marked this pull request as ready for review September 11, 2021 09:07
Copy link
Member

@SchoolGuy SchoolGuy left a comment

Choose a reason for hiding this comment

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

So the docs are not perfect yes. But this is a major improvement in my eyes! Let's get this into master. Fixups we can add later.

@SchoolGuy SchoolGuy merged commit 0e38927 into master Sep 11, 2021
V3.3.0 automation moved this from Pull Requests to Done Sep 11, 2021
@SchoolGuy SchoolGuy deleted the fix/items_docstrings branch September 11, 2021 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation main Not a release but referring to the Git main branch
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants