Skip to content

merge lint docs#16843

Merged
seanbudd merged 2 commits intomasterfrom
mergeLintDocs
Jul 11, 2024
Merged

merge lint docs#16843
seanbudd merged 2 commits intomasterfrom
mergeLintDocs

Conversation

@seanbudd
Copy link
Copy Markdown
Member

@seanbudd seanbudd commented Jul 11, 2024 •
edited by coderabbitai bot
Loading

Link to issue number:

Fixup of #16751

Summary of the issue:

The documentation for linting was fragmented.
It was not clear why a lint.md file was created as part of #16751 and related changes..
It was probably a result from migrating the Flake8 wiki to the document, and then whittling it down to the point where it became useless.
information on how to actually run the linter was missing from it

Description of development approach

removes lint.md change references to the automated testing doc

Summary by CodeRabbit

  • Documentation
    • Updated coding standards documentation to include Ruff linter for Python code style enforcement.
    • Clarified handling of lint warnings related to unused imports.
    • Revised instructions on linting processes and integration with development tools.

@seanbudd seanbudd requested review from a team as code owners July 11, 2024 04:28
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jul 11, 2024 •
edited
Loading

Walkthrough

The recent updates focus on refining the project's coding standards and automated testing documentation. Specifically, the codingStandards.md received an update to include a link to the Ruff linter for enforcing Python code style and guidelines for handling unused import warnings. The automated.md was revised to clarify the linting process, emphasizing the use of Ruff for Python linting and detailing the integration with development tools.

Changes

File Change Summary
projectDocs/dev/codingStandards.md Updated link to Ruff linter and added guidelines for handling lint warnings related to unused imports.
projectDocs/testing/automated.md Clarified the linting process, replaced NVDA's coding style mention with Ruff, and revised instructions for linting errors.

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.

SaschaCowley
SaschaCowley approved these changes Jul 11, 2024
View reviewed changes
@seanbudd seanbudd merged commit 1c2c960 into master Jul 11, 2024
@seanbudd seanbudd deleted the mergeLintDocs branch July 11, 2024 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SaschaCowley SaschaCowley SaschaCowley approved these changes

@Qchristensen Qchristensen Awaiting requested review from Qchristensen Qchristensen is a code owner automatically assigned from nvaccess/userdocs

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

@seanbudd @SaschaCowley