1689435 - Debugging on windows docs render with misleading `./mach run–debug` command

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, defect)

Description

[Bryce Seager van Dyk [:bryce] (he/him) - Not reading bugmail]

In https://firefox-source-docs.mozilla.org/contributing/debugging/debugging_on_windows.html#ways-to-start-the-debugger one of the ways of starting the debugger is listed as the command ./mach run –debug. However, this won't start the debugger if copy pasted, because the --debug switch has been rendered as –debug (an em dash instead of two dashes). Compare this to the source where two dashes are used: https://searchfox.org/mozilla-central/rev/4f07d49f1c7a823da07e3a231ac87c6435c8fd58/docs/contributing/debugging/debugging_on_windows.rst#33

Comment 1

[Shivam Singhal [ :championshuttler ]]

Thanks for filling it , it was just a direct import from MDN , may be if we put it in this format

.. code::

   ./mach run --debug

This might help in rendering it correctly and solve the issue.

Comment 2

[Shivam Singhal [ :championshuttler ]]

Attachment: Bug 1689435 - Fix the docs rendering for debugging part of windows building docs.r?sylvestre

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/2a85529b461a
Fix the docs rendering for debugging part of windows building docs.r=sylvestre DONTBUILD

Comment 4

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/2a85529b461a