Skip to content

Comment clarification/typo fixes about extensionPoints, across six files#14811

Merged
seanbudd merged 7 commits into
nvaccess:masterfrom
XLTechie:extPointCommentFixes
Apr 11, 2023
Merged

Comment clarification/typo fixes about extensionPoints, across six files#14811
seanbudd merged 7 commits into
nvaccess:masterfrom
XLTechie:extPointCommentFixes

Conversation

@XLTechie

@XLTechie XLTechie commented Apr 8, 2023

Copy link
Copy Markdown
Collaborator

Link to issue number:

None.

Summary of the issue:

While working on #14810, I found several places where comments about the core extensionPoints could be made clearer, or had typos/capitalization errors/questionable grammar.

Description of user facing changes

None.

Description of development approach

I fixed them as I went along, and scooped them all into their own branch. Here is the result.

I changed no code in this, and nothing structural has been altered. That is, where #: style comments were used in some places, and docstring style comments in others, I left them that way. I'm not actually sure what we prefer now. I wasn't trying to lint anything, just fix language.

Testing strategy:

Letting Appveyor build this branch in the PR, and see if any lint errors pop out. That's about all I would expect to find.

Known issues with pull request:

None, unless the mixed comment style is an issue. But I didn't do that.

Change log entries:

None needed.

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • 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
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

@XLTechie XLTechie marked this pull request as ready for review April 8, 2023 12:38
@XLTechie XLTechie requested a review from a team as a code owner April 8, 2023 12:38
@XLTechie XLTechie requested a review from seanbudd April 8, 2023 12:38
@AppVeyorBot

Copy link
Copy Markdown

See test results for failed build of commit 4eab7d5021

@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.

Approved, pending the lint fix

@XLTechie

Copy link
Copy Markdown
Collaborator Author

@seanbudd Linted, GTG

@seanbudd seanbudd merged commit e97b37a into nvaccess:master Apr 11, 2023
@nvaccessAuto nvaccessAuto added this to the 2023.2 milestone Apr 11, 2023
@XLTechie XLTechie deleted the extPointCommentFixes branch April 19, 2023 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants