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

completion: add additional documentation #731

Merged
merged 4 commits into from
Jun 6, 2024

Conversation

oliver-sanders
Copy link
Member

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@oliver-sanders oliver-sanders added the content Addition or modification of documentation label May 10, 2024
@oliver-sanders oliver-sanders added this to the 8.3.0 milestone May 10, 2024
@oliver-sanders oliver-sanders self-assigned this May 10, 2024
@oliver-sanders oliver-sanders changed the title Opt outputs completion: add additional documentation May 10, 2024
@oliver-sanders
Copy link
Member Author

(rebased)

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.

Couple of minor suggestions

src/reference/changes.rst Outdated Show resolved Hide resolved
required output in the graph, then these must also
be produced.

At Cylc 8.3.0 it is now possible to manually configure this completion
Copy link
Member

Choose a reason for hiding this comment

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

No biggie, but we'd normally not say this here (put an "added in version ..." note instead?)

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure we'd do that in changes.rst - or the whole document would be a storm of .. versionadded:: directives.

src/reference/changes.rst Outdated Show resolved Hide resolved
src/user-guide/writing-workflows/scheduling.rst Outdated Show resolved Hide resolved
src/user-guide/writing-workflows/scheduling.rst Outdated Show resolved Hide resolved
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
@oliver-sanders oliver-sanders requested a review from wxtim June 5, 2024 12:28
Copy link
Member

@wxtim wxtim left a comment

Choose a reason for hiding this comment

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

I'm happy with this - merge with or without my suggestion.

I'm not sure Hilary's outstanding comment is a good idea either.

src/user-guide/writing-workflows/scheduling.rst Outdated Show resolved Hide resolved
Co-authored-by: Tim Pillinger <26465611+wxtim@users.noreply.github.com>
@oliver-sanders
Copy link
Member Author

Just the two errors present on master, being fixed in another PR:

/home/runner/work/cylc-doc/cylc-doc/src/glossary.rst:83: WARNING: cylc:conf reference target not found: incomplete
/home/runner/work/cylc-doc/cylc-doc/src/glossary.rst:1693: WARNING: undefined label: 'active cycle point'

@oliver-sanders oliver-sanders merged commit b8a521e into cylc:master Jun 6, 2024
1 check failed
@oliver-sanders oliver-sanders deleted the opt-outputs branch June 6, 2024 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants