Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[libc] tiny fix for doc #80512

Merged
merged 2 commits into from
Feb 5, 2024
Merged

Conversation

SchrodingerZhu
Copy link
Contributor

@SchrodingerZhu SchrodingerZhu commented Feb 2, 2024

  • Correct my mistake of "reusing" bit operations in search-related doc.
  • Unify naming style.

@llvmbot
Copy link
Collaborator

llvmbot commented Feb 3, 2024

@llvm/pr-subscribers-libc

Author: Schrodinger ZHU Yifan (SchrodingerZhu)

Changes

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

2 Files Affected:

  • (modified) libc/docs/search.rst (+1-1)
  • (modified) libc/docs/stdbit.rst (+1-1)
diff --git a/libc/docs/search.rst b/libc/docs/search.rst
index 4233bfa8a7197..ff6a41911d3d6 100644
--- a/libc/docs/search.rst
+++ b/libc/docs/search.rst
@@ -8,7 +8,7 @@ Search Tables
 Source Location
 ---------------
 
--   The main source for bitwise utility functions is located at:
+-   The main source for search functions is located at:
     ``libc/src/search``.
 
 -   Hashtable implementation is located at:
diff --git a/libc/docs/stdbit.rst b/libc/docs/stdbit.rst
index 2dd91107dcc45..4f242d21f8b84 100644
--- a/libc/docs/stdbit.rst
+++ b/libc/docs/stdbit.rst
@@ -5,7 +5,7 @@ Bitwise Utility Functions
 .. include:: check.rst
 
 ---------------
-Source location
+Source Location
 ---------------
 
 -   The main source for bitwise utility functions is located at:

@SchrodingerZhu
Copy link
Contributor Author

SchrodingerZhu commented Feb 3, 2024

I myself put a hold on this. I just noticed that search seems to have special meaning in rst.

https://libc.llvm.org/search.html is the real Search Page instead of our doc.


updated

Copy link
Member

@nickdesaulniers nickdesaulniers left a comment

Choose a reason for hiding this comment

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

thanks! ☄️ 🤖

@SchrodingerZhu SchrodingerZhu merged commit a40d68b into llvm:main Feb 5, 2024
5 checks passed
@SchrodingerZhu SchrodingerZhu deleted the lib/doc/fix branch February 5, 2024 19:19
agozillon pushed a commit to agozillon/llvm-project that referenced this pull request Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants