Skip to content

UpdateBuilding user documentation module: Update markdown to nh3#16725

Merged
seanbudd merged 4 commits into
nvaccess:masterfrom
dpy013:Update-Building-user-documentation
Jun 26, 2024
Merged

UpdateBuilding user documentation module: Update markdown to nh3#16725
seanbudd merged 4 commits into
nvaccess:masterfrom
dpy013:Update-Building-user-documentation

Conversation

@dpy013

@dpy013 dpy013 commented Jun 21, 2024 •
edited by seanbudd
Loading

Copy link
Copy Markdown
Contributor

Link to issue number:

Follow up to #16724

Summary of the issue:

markdown 3.5.1 to 3.6
Updating python markdown to get the latest security updates
modifications

Description of user facing changes

none

Description of development approach

Updated markdown and nh3 versions of requirements.txt file

Testing strategy:

Careful review of the generated documentation is required

Known issues with pull request:

Not found at the moment

Code Review Checklist:

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

Summary by CodeRabbit

  • Chores
    • Updated dependencies to improve security and stability:
      • Markdown updated from 3.5.1 to 3.6.0.
      • nh3 updated from 0.2.15 to 0.2.17.

@dpy013
UpdateBuilding user documentation
9027fbe 
markdown 3.5.1 to 3.6
nh30.2.15 to nh30.2.17
@dpy013 dpy013 requested a review from a team as a code owner June 21, 2024 00:32
@dpy013 dpy013 requested a review from seanbudd June 21, 2024 00:32
@coderabbitai

coderabbitai Bot commented Jun 21, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The requirements.txt file has been updated to incorporate more recent versions of existing dependencies. Specifically, the Markdown library was upgraded from version 3.5.1 to 3.6.0, and the nh3 library was upgraded from version 0.2.15 to 0.2.17. These updates aim to leverage improvements and bug fixes present in the newer versions of these libraries.

Changes

File Change Summary
requirements.txt Updated Markdown from 3.5.1 to 3.6.0 and nh3 from 0.2.15 to 0.2.17.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@seanbudd

seanbudd commented Jun 21, 2024

Copy link
Copy Markdown
Member

this appears to be a duplicate of #16724 ?

@dpy013 dpy013 changed the title UpdateBuilding user documentation: Update markdown to nh3 UpdateBuilding user documentation module: Update markdown to nh3 Jun 21, 2024
@dpy013

dpy013 commented Jun 21, 2024

Copy link
Copy Markdown
Contributor Author

this appears to be a duplicate of #16724 ?
PR 16724 has been abandoned.
As a new contributor, PR 16724 is not a reasonable pull request. It contains too many updates and lacks rigor.
As a result, I will be splitting pull request 16724 into smaller, more centralized parts and submitting only the useful and safe parts.
I apologize for the previous redundant pull request.

seanbudd
seanbudd reviewed Jun 25, 2024
View reviewed changes
Comment thread user_docs/en/changes.md Outdated
* Updated LibLouis Braille translator to [3.30.0](https://github.com/liblouis/liblouis/releases/tag/v3.30.0). (#16652, @codeofdusk)
* New Braille tables for Cyrillic Serbian, Yiddish, several ancient languages (Biblical Hebrew, Akkadian, Syriac, and Ugaritic), and transliterated Cuneiform text.
* Updated NSIS 3.09 to 3.10 (#16674, @dpy013)
* Updated python markdown and nh3 to latest(#16725, @dpy013)

@seanbudd seanbudd Jun 25, 2024

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.

please add version numbers and new entries like the other items in this list

@seanbudd

seanbudd commented Jun 25, 2024

Copy link
Copy Markdown
Member

Can you please outline the testing you performed? What did the careful review involve?

@dpy013

dpy013 commented Jun 25, 2024

Copy link
Copy Markdown
Contributor Author

I did the following tests:
1.1 download nvda_snapshot_pr16725-32533_changes.html and
nvda_snapshot_pr16725-32559_changes.html
1.2 Two files were opened using Microsoft Edge and chrome browsers.
The links, headings, and tables were tested to see if they could be viewed correctly with screen readers and browsers.
1.3 Finally tested nvda pr16725
and
userGuide.html
The links, tables, and forms can be viewed correctly with screen readers and browsers.

@seanbudd seanbudd merged commit 922d300 into nvaccess:master Jun 26, 2024
@seanbudd

seanbudd commented Jun 26, 2024

Copy link
Copy Markdown
Member

Thanks @dpy013

@dpy013 dpy013 deleted the Update-Building-user-documentation branch June 26, 2024 00:29
@coderabbitai coderabbitai Bot mentioned this pull request Jun 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dpy013 @seanbudd