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

add reference labels #683

Merged
merged 1 commit into from
Jan 30, 2024
Merged

add reference labels #683

merged 1 commit into from
Jan 30, 2024

Conversation

oliver-sanders
Copy link
Member

Add a couple of labels so we can reference these sections from other places.

Requirements check-list

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

@oliver-sanders oliver-sanders added this to the 8.3.0 milestone Jan 30, 2024
@oliver-sanders oliver-sanders requested a review from wxtim January 30, 2024 13:10
@oliver-sanders oliver-sanders self-assigned this Jan 30, 2024
@oliver-sanders
Copy link
Member Author

oliver-sanders commented Jan 30, 2024

Test failures are unrelated. Fixed on #682

They are the result of spellchecking running over the API docs and complaining about variable names like kwargs and cfg.

As we expand our API docs, spellchecking is going to be increasingly difficult to manage.

@wxtim
Copy link
Member

wxtim commented Jan 30, 2024

Test failures are unrelated. Fixed on #682

They are the result of spellchecking running over the API docs and complaining about variable names like kwargs and cfg.

As we expand our API docs, spellchecking is going to be increasingly difficult to manage.

Yes. Sadly.

Although I think that it's worth considering whether non dictionary words are reasonable in code: I think that (at least in this project) we recognise ctx, cfg and kwargs such that it's reasonable to use them. But if spellchecker starts catching us using weird/obscure terms/contractions then we should probably consider whether those are OK.

@wxtim wxtim merged commit 75deb23 into cylc:master Jan 30, 2024
1 check failed
@oliver-sanders oliver-sanders deleted the add-labels branch January 30, 2024 13:57
@oliver-sanders
Copy link
Member Author

Although I think that it's worth considering whether non dictionary words are reasonable in code

Yes they are!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants