UG > PagNav: Misleading sentence #2440
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2440 +/- ##
=======================================
Coverage 48.92% 48.92%
=======================================
Files 124 124
Lines 5245 5245
Branches 1110 1110
=======================================
Hits 2566 2566
Misses 2371 2371
Partials 308 308 ☔ View full report in Codecov by Sentry. |
damithc
reviewed
Mar 3, 2024
| @@ -4,7 +4,7 @@ | |||
|
|
|||
| <div id="content"> | |||
|
|
|||
| **A _Page Navigation Menu_ (==_pageNav_ for short==) a list of the current page's headings.** Page navigation menus are only available for use in [layouts]({{baseUrl}}/userGuide/tweakingThePageStructure.html#layouts). | |||
| **A _Page Navigation Menu_ (==_pageNav_ for short==) displays a list of the current page's headings.** Page navigation menus are typically used in [layouts]({{baseUrl}}/userGuide/tweakingThePageStructure.html#layouts), but they can also be utilized in individual pages. | |||
There was a problem hiding this comment.
'used in layouts' still doesn't sound right. It's more like set/configured/controlled via the layouts mechanism.
…inEyo1/markbind into 2412-fix-misleading-sentence
yucheng11122017
approved these changes
Mar 7, 2024
itsyme
reviewed
Mar 8, 2024
|
LGTM! Thanks for the work @KevinEyo1 |
itsyme
approved these changes
Mar 9, 2024
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.
What is the purpose of this pull request?
Overview of changes:
Fixes #2412
Updated documentation to avoid misleading wording.
Anything you'd like to highlight/discuss:
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
UG: update wording of UG
Wording might mislead readers into thinking that PageNavs
cannot be used in normal pages.
Updating the wording will allow readers to know that
individual pages can also use PageNavs.
Let's update the wording to be clearer and more explicit.
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):