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.

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

Jump to bottom

expand schema docstring internally #4926

Merged
merged 2 commits into from
Jun 23, 2022
Merged

expand schema docstring internally #4926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cae06b
expand schema docstrings directly
dwsutherland Jun 22, 2022
6312fa5
change log entry
dwsutherland Jun 23, 2022
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
3 changes: 3 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ in `global.cylc[install]source dirs`.

### Fixes

[#4926](https://github.com/cylc/cylc-flow/pull/4926) - Fix a docstring
formatting problem presenting in the UI mutation flow argument info.

[#4891](https://github.com/cylc/cylc-flow/pull/4891) - Fix bug that could cause
past jobs to be omitted in the UI.

Expand Down
12 changes: 3 additions & 9 deletions cylc/flow/network/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1391,15 +1391,9 @@ def description(self):


class Flow(String):
"""An integer or one of {FLOW_ALL}, {FLOW_NEW} or {FLOW_NONE}."""


# NOTE: docstrings can't be f-strings so we must manually format it.
Flow.__doc__ = Flow.__doc__.format( # type: ignore[union-attr]
FLOW_ALL=FLOW_ALL,
FLOW_NEW=FLOW_NEW,
FLOW_NONE=FLOW_NONE,
)
__doc__ = (
f"""An integer or one of {FLOW_ALL}, {FLOW_NEW} or {FLOW_NONE}."""
)


# Mutations:
Expand Down