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

Fix docs indentation #68

Merged

Conversation

MetRonnie
Copy link

No description provided.

Comment on lines +1168 to +1170
with Conf('<install target>', desc=dedent("""
:ref:`Host <Install targets>` on which to create the symlinks.
""" + COMMA_SEPARATED_SECTION_NOTE):
""") + COMMA_SEPARATED_SECTION_NOTE):
Copy link
Author

Choose a reason for hiding this comment

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

This is how it's done elsewhere:

with Conf('job', desc=REPLACED_BY_PLATFORMS + dedent('''
This section configures the means by which cylc submits task
job scripts to run.
''')):

@@ -1253,7 +1253,7 @@ def default_for(
Platform names can be regular expressions: If you have a set of
compute resources such as ``bigmachine1, bigmachine2`` or
``desktop0000, .., desktop9999`` one would define platforms with
names ``[[bigmachine[12]]]`` and ``[[desktop[0-9]{{4}}]]``.
names ``[[bigmachine[12]]]`` and ``[[desktop[0-9]{4}]]``.
Copy link
Author

Choose a reason for hiding this comment

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

(As I've made it not an f-string anymore)

@wxtim wxtim merged commit 640381a into wxtim:feature.commas-in-install_target_sections Nov 20, 2024
25 of 26 checks passed
@MetRonnie MetRonnie deleted the dedent-fun branch November 20, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants