Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: Add documentation for toolbar get_object and set_object methods #8314

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 21, 2025
Merged

docs: Add documentation for toolbar get_object and set_object methods #8314

merged 1 commit into from
Aug 21, 2025

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Aug 21, 2025 •
edited by sourcery-ai bot
Loading

Description

Related resources

  • #...
  • #...

Checklist

Summary by Sourcery

Document the toolbar's object association functionality by adding detailed docstrings to its methods and updating the user guide.

Documentation:

  • Add docstrings for Toolbar.set_object to explain its intent, parameters, and usage
  • Add docstrings for Toolbar.get_object to describe its return value and usage

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Aug 21, 2025 •
edited
Loading

Reviewer's Guide

Augment the toolbar module by adding detailed docstrings to set_object and get_object methods, and update the placeholders guide to document their usage.

Class diagram for updated Toolbar object association methods

classDiagram
    class Toolbar {
        +obj: Model
        +set_object(obj: Model)
        +get_object() Model | None
    }
    Toolbar : set_object(obj)
    Toolbar : get_object()
    Toolbar --> "1" Model : associates
Loading

File-Level Changes

Change Details Files
Added docstrings to toolbar's set_object and get_object methods.
  • Document set_object behaviour and parameters
  • Clarify get_object return value and usage
 cms/toolbar/toolbar.py
Updated placeholders documentation to include get_object and set_object usage.
  • Explain how to associate objects with the toolbar
  • Describe retrieving the associated object via get_object
 docs/how_to/01-placeholders.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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

sourcery-ai[bot]
sourcery-ai bot reviewed Aug 21, 2025
View reviewed changes
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 there - I've reviewed your changes and they look great!

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.

@github-actions GitHub Actions
Copy link

👋 Hi there!

Please remember to MERGE COMMIT pull requests from main!

Do not SQUASH commits to preserve history for the changelog.

@fsbraun fsbraun merged commit c2b3fa6 into release/5.0.x Aug 21, 2025
69 checks passed
@fsbraun fsbraun deleted the chore/backport-8321 branch August 21, 2025 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] 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.
1 participant
@fsbraun