search

oasis-open / tosca-community-contributions

OASIS TC Open Repository: Manages TOSCA profiles, tests, and templates that are maintained by the TOSCA community. They are intended to be used as examples to help developers get started with TOSCA and to test compliance of TOSCA implementations with the standard.
https://github.com/oasis-open/tosca-community-contributions
Apache License 2.0
39 stars 25 forks source link

Some comments have not been correctly handled when converting to markdown #162

Closed pmjordan closed 3 months ago

pmjordan commented 10 months ago

There are still a number of places where comments have been either converted to text or omitted from the preview. See for example lines 285 - 300 where 'Mike Rehder' appears in the text but comment 95 from Calin does not appear in the preview.

lauwers commented 10 months ago

Comments are not supposed to show up in the rendered document, only in the markdown text itself. If comments show up (such as the Mike Rehder comment you're referencing) that is a big in the document.

pmjordan commented 10 months ago

OK. I'll see if I can find any other places where comments have leaked through to text. However it does seem that some comments are rendered deliberately e.g. lines 670-674

pmjordan commented 10 months ago

I found one more comment breaking thorugh at Lines 1969 - 1972 'MUSTFIX' and several occurances each of TODO TBD !!!

also dollar signs are cauing a problem in lines 7936 - 7937

pmjordan commented 3 months ago

This issue was addressed by https://github.com/oasis-tcs/tosca-specs/issues/61 so closing