search

common-workflow-language / user_guide

The CWL v1.0 - v1.2 user guide
http://www.commonwl.org/user_guide/
Other
41 stars 67 forks source link

Possible wrong ordering of sections in the Topics #406

Open zoe-translates opened 1 year ago

zoe-translates commented 1 year ago

https://github.com/common-workflow-language/user_guide/blob/dbeb91c9aa4e0343cc129f9986f9482986efe6a3/src/topics/parameter-references.md?plain=1#L3

Here the "previous example" seems to be a reference to src/topics/outputs.md. But in the current ordering of sections, parameter-refernece.md is Section 2.6 which comes before outputs.md at 2.7.

It seems their ordering should be reversed.

mr-c commented 1 year ago

How about "in the outputs example" with a link?

zoe-translates commented 1 year ago

Hi! I think the content of this section ("Parameter References") does build upon the "tar" example in "Outputs". For users going through the Topics in-order, the ordering would be meaningful, I think.

But if this is done by exchanging the order of these sections in topics/index.md, will that cause unintended complications, such as lost message translations in Weblate?