Skip to content

Fix the wrong rendering format of command line options in userGuide#15334

Merged
seanbudd merged 2 commits into
nvaccess:masterfrom
hwf1324:feature-Fix-userGuide-rendering
Aug 28, 2023
Merged

Fix the wrong rendering format of command line options in userGuide#15334
seanbudd merged 2 commits into
nvaccess:masterfrom
hwf1324:feature-Fix-userGuide-rendering

Conversation

@hwf1324

@hwf1324 hwf1324 commented Aug 27, 2023

Copy link
Copy Markdown
Contributor

Link to issue number:

none

Summary of the issue:

In the Command Line Options section of the user guide, a pair of --s on the line -copy-portable-config resulted in strikethrough rendering in the output HTML.

Description of user facing changes

All options are `` by backticks.

Description of development approach

All options are `` by backticks.

Testing strategy:

View the HTML built after the changes.

Known issues with pull request:

Change log entries:

New features
Changes
Bug fixes
For Developers

Code Review Checklist:

  • [ x] Pull Request description:
    • description is up to date
    • change log entries
  • [ x] Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • [x ] UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

@hwf1324 hwf1324 requested a review from a team as a code owner August 27, 2023 11:22
@hwf1324 hwf1324 requested a review from Qchristensen August 27, 2023 11:22
@hwf1324

hwf1324 commented Aug 27, 2023

Copy link
Copy Markdown
Contributor Author

nvda/user_docs/en/userGuide.t2t

Line 3946 in 1e30951

| Route to braille cell | routing set 1|

Is routing set 1 correct?

@hwf1324

hwf1324 commented Aug 27, 2023

Copy link
Copy Markdown
Contributor Author

Is there a way I can undo the first commit? I accidentally let it introduce a fix for too many trailing spaces.

seanbudd
seanbudd previously approved these changes Aug 28, 2023
View reviewed changes

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @hwf1324!

@seanbudd

seanbudd commented Aug 28, 2023

Copy link
Copy Markdown
Member

In the Command Line Options section of the user guide, a pair of --s on the line -copy-portable-config resulted in strikethrough rendering in the output HTML.

It seems like there are no changes related to this in the diff?

Is there a way I can undo the first commit? I accidentally let it introduce a fix for too many trailing spaces.

git rebase can help, however i'm not aware of any accessible documentation on this feature. most guides rely on diagrams.

It may be easier to start again, or fix these manually.

@seanbudd seanbudd dismissed their stale review August 28, 2023 01:27

accident

@seanbudd seanbudd marked this pull request as draft August 28, 2023 01:35
@hwf1324 hwf1324 force-pushed the feature-Fix-userGuide-rendering branch from 74ffb79 to 27a7235 Compare August 28, 2023 02:10
@hwf1324

hwf1324 commented Aug 28, 2023

Copy link
Copy Markdown
Contributor Author

Is there a way I can undo the first commit? I accidentally let it introduce a fix for too many trailing spaces.

has been re-changed.

@seanbudd seanbudd marked this pull request as ready for review August 28, 2023 03:37
@XLTechie

XLTechie commented Aug 28, 2023 via email

Copy link
Copy Markdown
Collaborator

seanbudd
seanbudd approved these changes Aug 28, 2023
View reviewed changes

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @hwf1324

@seanbudd seanbudd merged commit 3df7605 into nvaccess:master Aug 28, 2023
@nvaccessAuto nvaccessAuto added this to the 2023.3 milestone Aug 28, 2023
@hwf1324 hwf1324 deleted the feature-Fix-userGuide-rendering branch August 28, 2023 03:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd approved these changes

@Qchristensen Qchristensen Awaiting requested review from Qchristensen Qchristensen was automatically assigned from nvaccess/userdocs

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

2023.3

Development

Successfully merging this pull request may close these issues.

4 participants

@hwf1324 @seanbudd @XLTechie @nvaccessAuto