search

cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
8 stars 19 forks source link

add reference labels #683

Closed oliver-sanders closed 5 months ago

oliver-sanders commented 5 months ago

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

Requirements check-list

oliver-sanders commented 5 months ago

Test failures are unrelated. Fixed on https://github.com/cylc/cylc-doc/pull/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 commented 5 months ago

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.

oliver-sanders commented 5 months ago

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

Yes they are!