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

Fix heading levels of options/subclassing docs #3662

Conversation

DoctorJohn
Copy link
Member

@DoctorJohn DoctorJohn commented Oct 7, 2024

Description

I noticed the heading level hirachies were not quite right. The view and subclassing options should be one level below the options/subclassing sections.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Summary by Sourcery

Correct heading levels in the documentation for integration guides to improve readability and maintain a consistent structure across all sections.

Documentation:

  • Adjust heading levels in the documentation for various integrations to ensure consistent hierarchy, making sub-sections like 'get_context', 'get_root_value', 'process_result', and 'encode_json' appear as sub-headings under their respective main sections.

Copy link
Contributor

sourcery-ai bot commented Oct 7, 2024

Reviewer's Guide by Sourcery

This pull request adjusts the heading levels in the documentation for various integration options and subclassing sections. The changes are primarily focused on improving the hierarchy and readability of the documentation structure.

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

File-Level Changes

Change Details Files
Adjusted heading levels for integration options and subclassing sections
  • Changed heading levels from ## to ### for main option sections
  • Changed heading levels from ### to #### for sub-option sections
  • Maintained consistency across multiple integration files (asgi, fastapi, aiohttp, chalice, django, flask, quart, sanic, litestar)
docs/integrations/asgi.md
docs/integrations/fastapi.md
docs/integrations/aiohttp.md
docs/integrations/chalice.md
docs/integrations/django.md
docs/integrations/flask.md
docs/integrations/quart.md
docs/integrations/sanic.md
docs/integrations/litestar.md

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

@patrick91 patrick91 merged commit 7feeea9 into strawberry-graphql:main Oct 7, 2024
4 checks passed
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.

2 participants