Skip to content

Fix version_added #68

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix version_added #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2627cd
respect found version_added content
phospi Oct 12, 2021
1585ec3
respect documented version_added value and throw warning if it doesn'…
phospi Oct 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions collection_prep/cmd/update.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def update_deprecation_notice(documentation):

def update_documentation(bodypart):
"""
Update the docuementation of the module
Update the documentation of the module

:param bodypart: The DOCUMENTATION section of the module
"""
Expand All @@ -91,14 +91,17 @@ def update_documentation(bodypart):
update_deprecation_notice(documentation)

# remove version added
documentation.pop("version_added", None)
desc_idx = [
idx
for idx, key in enumerate(documentation.keys())
if key == "description"
]
# insert version_added after the description
documentation.insert(desc_idx[0] + 1, key="version_added", value="1.0.0")
version_added = documentation.pop("version_added", None)
if version_added is not None:
desc_idx = [
idx
for idx, key in enumerate(documentation.keys())
if key == "description"
]
# insert version_added after the description
documentation.insert(desc_idx[0] + 1, key="version_added", value=version_added)
else:
logging.warning("Field 'version_added' not found.")
repl = ruamel.yaml.dump(documentation, None, ruamel.yaml.RoundTripDumper)

# remove version added from anywhere else in the docstring if preceded by 1+ spaces
Expand Down