[docs] Fix invalid header length in llvm-ir2vec.rst

[keith]

This also improves the error message to be more clear for folks who
haven't used a lot of rst.

[keith]

came up in #167987

[llvmbot]

@llvm/pr-subscribers-mlgo

@llvm/pr-subscribers-llvm-binary-utilities

Author: Keith Smiley (keith)

Changes

This also improves the error message to be more clear for folks who
haven't used a lot of rst.

---

Full diff: https://github.com/llvm/llvm-project/pull/168104.diff

2 Files Affected:

• (modified) llvm/docs/CommandGuide/llvm-ir2vec.rst (+1-1)
• (modified) llvm/docs/conf.py (+1-1)

diff --git a/llvm/docs/CommandGuide/llvm-ir2vec.rst b/llvm/docs/CommandGuide/llvm-ir2vec.rst index f51da065b43d8..6014df941147e 100644 --- a/llvm/docs/CommandGuide/llvm-ir2vec.rst +++ b/llvm/docs/CommandGuide/llvm-ir2vec.rst @@ -1,5 +1,5 @@ llvm-ir2vec - IR2Vec and MIR2Vec Embedding Generation Tool -=========================================================== +========================================================== .. program:: llvm-ir2vec diff --git a/llvm/docs/conf.py b/llvm/docs/conf.py index d9fa6961032b4..ac06c8dc45ba7 100644 --- a/llvm/docs/conf.py +++ b/llvm/docs/conf.py @@ -273,7 +273,7 @@ def process_rst(name): if len(header) != len(title): print( - "error: invalid header in %r (does not match title)" % file_subpath, + "error: invalid header length in %r (does not match length of title)" % file_subpath, file=sys.stderr, ) if " - " not in title: 

[github-actions]

✅ With the latest revision this PR passed the Python code formatter.

[boomanaiden154]

LGTM, module python formatting fixes.