This is an archive of the discontinued LLVM Phabricator instance.

[Docs] Fix --print-supported-cpus option rendering
ClosedPublic

Authored by tmfink on Aug 8 2020, 9:14 PM.

Details

Summary

Adds link/code sample to avoid rendering two dashes as non-ASCII "en dash".
Also make wording a complete sentence.

Diff Detail

Event Timeline

tmfink requested review of this revision.Aug 8 2020, 9:14 PM
tmfink created this revision.
clang/docs/CommandGuide/clang.rst
346

Would you mind adding a . for punctuation while you're here?

tmfink added inline comments.Aug 23 2020, 6:57 PM
clang/docs/CommandGuide/clang.rst
346

This is not a complete sentence (no predicate/verb), so from a grammar point of view, a period does not make sense.

It seems like the other options use complete sentences (with a period).

I'll reword this description to match the style of the other options (so a period will make sense).

tmfink updated this revision to Diff 287290.Aug 23 2020, 8:18 PM

Fix rendering of --print-supported-cpus option and make alias documentation a
complete sentence.

tmfink marked an inline comment as done.Aug 23 2020, 8:19 PM
tmfink retitled this revision from [Docs] Link to --print-supported-cpus option to [Docs] Fix rendering for --print-supported-cpus option.
tmfink retitled this revision from [Docs] Fix rendering for --print-supported-cpus option to [Docs] Fix --print-supported-cpus option rendering.
tmfink edited the summary of this revision. (Show Details)
nickdesaulniers accepted this revision.Aug 27 2020, 9:50 PM
This revision is now accepted and ready to land.Aug 27 2020, 9:50 PM
tmfink removed a reviewer: ziangwan.Sep 2 2020, 8:15 AM
tmfink accepted this revision.Sep 3 2020, 9:46 PM

@nickdesaulniers, could you merge my patch? I don't have commit access.
Thanks!

This revision was automatically updated to reflect the committed changes.