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

merged 2 commits into from
Jun 23, 2022

Conversation

dwsutherland
Copy link
Member

@dwsutherland dwsutherland commented Jun 22, 2022 •
edited
Loading

These changes close #4898
image

image

(flow) sutherlander@graphic-vbox:cylc-flow$ python -c 'from cylc.flow.network.schema import Flow; print(Flow.__doc__); print(Flow().__doc__)'
An integer or one of all, new or none.
An integer or one of all, new or none.

(note: I don't know why the previous arrangement didn't work at the UI, but this does)

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg and conda-environment.yml.
  • Covered functionally by existing tests, aesthetically by UI (could write a graphql introspection query, however python functionality really).
  • Appropriate change log entry included.
  • No documentation update required.

@dwsutherland dwsutherland self-assigned this Jun 22, 2022
@dwsutherland dwsutherland added this to the cylc-8.0rc4 milestone Jun 22, 2022
@dwsutherland dwsutherland changed the title expand schema docstrings directly expand schema docstring internally Jun 23, 2022
hjoliver
hjoliver approved these changes Jun 23, 2022
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

👍

@MetRonnie MetRonnie removed the request for review from oliver-sanders June 23, 2022 06:57
@MetRonnie MetRonnie added bug Something is wrong :( small labels Jun 23, 2022
@MetRonnie MetRonnie merged commit 2c1ecf8 into cylc:master Jun 23, 2022
wxtim added a commit to wxtim/cylc that referenced this pull request Jul 4, 2022
@wxtim
Merge branch 'master' into cylc-linter.bk
8dec7ca 
* master: (30 commits)
  Log dir tidy (cylc#4836)
  Cut down on back-compat warnings, plus other tidying (cylc#4943)
  Validate platform settings (background job runner) (cylc#4938)
  clean: push error message to stderr
  Update cylc/flow/id_match.py
  Fix unintended directory stripping during cylc install (cylc#4931)
  stop cylc validate swallowing useful errors (cylc#4936)
  Improve config reference docs (cylc#4916)
  glblcfg: increase default rolling archive length
  Fix job state with pre-submitted failure
  Update tests/functional/cylc-reinstall/02-failures.t
  reinstall: require workflow ID argument
  play: upgrade --start-task's specified in legacy format (cylc#4925)
  expand schema docstring internally (cylc#4926)
  Added a new task filtering test.
  Add comment [skip ci]
  Fix optparse Options class for std options (cylc#4919)
  uid: warn if the run number is provided as a cycle
  Tweak prev.
  Fix task filtering.
  ...
@hjoliver hjoliver modified the milestones: cylc-8.0rc4, cylc-8.0.0 Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver approved these changes

@MetRonnie MetRonnie MetRonnie approved these changes

Assignees

@dwsutherland dwsutherland

Labels
bug Something is wrong :( small
Projects
None yet
Milestone
cylc-8.0.0
Development

Successfully merging this pull request may close these issues.

Flow docstring formatting problem
3 participants
@dwsutherland @hjoliver @MetRonnie