Skip to content

Conversation

@keith
Copy link
Member

@keith keith commented Nov 14, 2025

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

@keith
Copy link
Member Author

keith commented Nov 14, 2025

came up in #167987

@llvmbot
Copy link
Member

llvmbot commented Nov 14, 2025

@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
Copy link

github-actions bot commented Nov 14, 2025

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

This also improves the error message to be more clear for folks who
haven't used a lot of rst.
@keith keith force-pushed the ks/docs-fix-invalid-header-length-in-llvm-ir2vec.rst branch from 56b9c52 to 17f677f Compare November 14, 2025 19:01
Copy link
Contributor

@boomanaiden154 boomanaiden154 left a comment

Choose a reason for hiding this comment

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

LGTM, module python formatting fixes.

@keith keith merged commit 0bdbf2c into llvm:main Nov 14, 2025
9 of 10 checks passed
@keith keith deleted the ks/docs-fix-invalid-header-length-in-llvm-ir2vec.rst branch November 14, 2025 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants