Restore command help reference section #237
Conversation
|
Building the docs on this branch revealed cylc/cylc-flow#4171 |
|
|
hjoliver
force-pushed
the
restore-command-ref
branch
from
708f239
to
2d08794
Compare
| END | ||
|
|
||
| for COM in $($CYLC commands); do | ||
| for COM in $(cylc help all | awk '{print $1}' | sort); do |
There was a problem hiding this comment.
CI build failed, I think because this line doesn't work if the terminal width is too low ?? (newlines get inserted into the help text)
There was a problem hiding this comment.
Would have to be narrower than the longest command name to trip awk up?!
|
This was kinda purposefully removed pending conversion to Of course we can keep the old CLI help for now though but be aware that all of the references will change when we change implementation. |
|
Oh yeah. From that Issue, I guess this PR restores the option of final resort:
Looking at the command ref section (or the image above) it probably is quite useful to have. All the command names are visible at once, and you can click on them to instantly see what they do (to state the obvious). If the aim is to retain the command reference but generate it by more sophisticated means, then I think we should keep the old way until we have that. Users don't care about the implementation. |
|
Fair enough, we can put it back in for now with the caveat that anyone who links into this page has automatically volunteered to fix the references later 😈. (the main reason I pulled it out before putting the new one in is because it took an age to run for each build). |
|
It is slow. On my box 12 secs. (Out of an 18 sec build time). |
|
Closing, there's no great need for this. |
As far as I recall we didn't decided to ditch the CLI command help reference section of the User Guide??
Maybe we just disabled it when the generator script broke after removing the old command "categories" in the cylc-flow CLI.
If we want to restore it, it's an easy fix. Any strong opinions?