This is an archive of the discontinued LLVM Phabricator instance.

[Docs] Fix code-blocks missing colon
ClosedPublic

Authored by rogfer01 on Jul 27 2023, 8:00 AM.

Details

Summary

I was reading ORCv2 HTML documentation and I found the text mentioned examples that were not present. Turns out there were some syntax issues in the reStructuedText file that prevented rendering them.

I did a grep through the rest of the docs and I found a few other instances of the problem, including missing newlines.

I was pleased to discover that clang attributes nodiscard / warn_unused_result had a couple useful example that had never been rendered!

Diff Detail

Event Timeline

rogfer01 created this revision.Jul 27 2023, 8:00 AM
Herald added a reviewer: njames93. · View Herald Transcript
Herald added a project: Restricted Project. · View Herald Transcript
rogfer01 requested review of this revision.Jul 27 2023, 8:00 AM
Herald added projects: Restricted Project, Restricted Project, Restricted Project. · View Herald TranscriptJul 27 2023, 8:00 AM
PiotrZSL accepted this revision.Jul 27 2023, 8:05 AM

Thank you.
LGTM

This revision is now accepted and ready to land.Jul 27 2023, 8:05 AM
aaron.ballman accepted this revision.Jul 27 2023, 8:06 AM

LGTM, good catch! It'd be nice if we could somehow configure Sphinx to complain about this issue so we'd catch it proactively with the sphinx build bots.

This revision was landed with ongoing or failed builds.Jul 27 2023, 10:39 PM
This revision was automatically updated to reflect the committed changes.