Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Revise table of contents and fix typos #249

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Nov 25, 2024

Summary by Sourcery

Update the documentation by revising the table of contents and correcting typos.

Documentation:

  • Update the table of contents in the documentation.
  • Fix typos in the documentation.

Copy link
Contributor

sourcery-ai bot commented Nov 25, 2024

Reviewer's Guide by Sourcery

This pull request makes minor documentation improvements by updating the table of contents and fixing typographical errors in the documentation files.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Documentation maintenance and cleanup
  • Updated table of contents structure
  • Fixed typographical errors in documentation
docs/source/components.rst
docs/source/index.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @fsbraun - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@fsbraun fsbraun changed the title docs: Update toc, typos @sourcery-ai Nov 25, 2024
@sourcery-ai sourcery-ai bot changed the title @sourcery-ai docs: Revise table of contents and fix typos Nov 25, 2024
@fsbraun fsbraun merged commit 465a4ba into master Nov 25, 2024
36 checks passed
@fsbraun fsbraun deleted the fsbraun-patch-1 branch November 25, 2024 15:59
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.

1 participant