Introduce cleveref package for cross-references #346
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
EricccTaiwan
approved these changes
Sep 9, 2025
EricccTaiwan
suggested changes
Sep 9, 2025
Introduce the 'cleveref' package to the document. This package allows
for intelligent cross-referencing that automatically includes the
reference type (e.g., "Section" or "Figure").
The change replaces all instances of \ref{...} with \Cref{...}. This
improves document readability and simplifies maintenance by removing the
need for manual text prefixes like "Section" or "Figure" before a
reference.
This aligns with contributor suggestions to adopt cleveref for better
maintenance of cross-references across the document.
Signed-off-by: Chia-Hao Chiu <[email protected]>
Jordymalone
force-pushed
the
add-cref
branch
from
05a0f04 to
432f007
Compare
|
Thank @Jordymalone for contributing! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce the 'cleveref' package to the document. This package allows for intelligent cross-referencing that automatically includes the reference type (e.g., "Section" or "Figure").
The change replaces all instances of
\ref{...}with\Cref{...}. This improves document readability and simplifies maintenance by removing the need for manual text prefixes like "Section" or "Figure" before a reference.This aligns with contributor suggestions to adopt cleveref for better maintenance of cross-references across the document.
Summary by cubic
Add the cleveref package and switch all cross-references from \ref to \Cref for automatic, type-aware labels. This improves readability and removes the need for manual "Section"/"Figure" prefixes.