Skip to content

Conversation

@andrew-codes
Copy link
Contributor

@andrew-codes andrew-codes commented Oct 31, 2019

  • changelog.js
  • note.js now renders with rawRender

Blocks of <code>--arg</code> are converted to <code>-arg</code>. This does not occur when code is within a code block; i.e.

`--arg`

The desire is to maintain the double -- in output. A fix was put in for note.js in PR #935. This fix was moved to rawRender.js so that any renderer using this will pick up this fix; including changelog.js. Also, update note.js to leverage rawRender.

Close #2196

….js`- `note.js` now renders with rawRender
`Note.js` update to reflect that rawRender returns a promise and not a string
@andrew-codes andrew-codes changed the title provide proper --args for any place utilizing rawRender [WIP] provide proper --args for any place utilizing rawRender Oct 31, 2019
@andrew-codes
Copy link
Contributor Author

Closing for now to explore upgrading marked dep

@andrew-codes
Copy link
Contributor Author

Reopening this PR: the alternative approach of upgrading seems like a decent size undertaking.

@andrew-codes andrew-codes reopened this Oct 31, 2019
@andrew-codes andrew-codes changed the title [WIP] provide proper --args for any place utilizing rawRender provide proper --args for any place utilizing rawRender Oct 31, 2019
@andrew-codes andrew-codes changed the title provide proper --args for any place utilizing rawRender Provide proper --args for any place utilizing rawRender Oct 31, 2019
@andrew-codes
Copy link
Contributor Author

andrew-codes commented Oct 31, 2019

Note: this will not fix cases where more than a fenced code block in the %{ url } helper like below:

 {% url "`--config-file` argument" command-line#cypress-run-config-file-lt-config-file-gt %}

@jennifer-shehane
Copy link
Member

This does fix cases where the -- is in a fenced code block in a url, but not the first characters. The below renders correctly:

{% url "`cypress run --browser chrome`" command-line#cypress-run-browser-lt-browser-name-or-path-gt %}

@jennifer-shehane
Copy link
Member

Actually, I'm starting to think that this issue was always isolated to text within code blocks within urls where the beginning text was --. Is there any evidence this has fixed any cases in the changelog that existed before?

@andrew-codes
Copy link
Contributor Author

It does appear to fix some as shown in the below image; just not all.

image

Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this partially addresses things. Thanks!

@jennifer-shehane jennifer-shehane merged commit e9aa0a3 into develop Nov 4, 2019
@oak-wildwood
Copy link

Looks like this might have broken the notes tag rendering.

@matthamil matthamil deleted the issue-2196 branch April 14, 2021 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--arg not writing -- when in inline code blocks

3 participants