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

Skip to content

Fixed #26007: Update the doc string on get_template_names of SingleObjectTemplateResponseMixin #18923

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 2 commits into from
Dec 18, 2024
Merged

Fixed #26007: Update the doc string on get_template_names of SingleObjectTemplateResponseMixin #18923

merged 2 commits into from
Dec 18, 2024

Conversation

nanorepublica
Copy link
Contributor

@nanorepublica nanorepublica commented Dec 11, 2024 •
edited
Loading

Trac ticket number

ticket-26007

Branch description

  • Updated doc string of get_template_names to clarify how the list gets returned
  • Updated the error message to be clearer when the view is incorrectly configured.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

carltongibson
carltongibson approved these changes Dec 12, 2024
View reviewed changes
Copy link
Member

@carltongibson carltongibson left a comment

Choose a reason for hiding this comment

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

Looks good 👍 Just left a couple of comments.

timgraham
timgraham reviewed Dec 13, 2024
View reviewed changes
Copy link
Member

@timgraham timgraham left a comment

Choose a reason for hiding this comment

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

This point could be debated, but if I were writing this patch I'd separate this into two commits, one for the code change and one for the docs/docstring, since one is behavioral and one is cosmetic. While a bit related, they really are separate issues.

And try to use more specific language in the PR title/commit messages. "Updated docstring to be clearer on the list returned from the function." could apply to anything!

@nanorepublica nanorepublica changed the title Fixed #26007: Updated docstring to be clearer on the list returned from the function. Fixed #26007: Update the doc string on get_template_names of SingleObjectTemplateResponseMixin Dec 13, 2024
@nanorepublica
Copy link
Contributor Author

Thanks for the comments Tim. I will split this into 2 patches for clarity. This PR now just the doc string changes, I will get another PR for the error message.

@carltongibson
Copy link
Member

@nanorepublica Two separate commits in the same PR would be OK. (That's right no Tim?)

@nanorepublica
Copy link
Contributor Author

🤦‍♂️ clearly I shouldn't be doing this last thing before the weekend! I will get this sorted when I am next at my laptop

sarahboyce
sarahboyce approved these changes Dec 18, 2024
View reviewed changes
Copy link
Contributor

@sarahboyce sarahboyce left a comment

Choose a reason for hiding this comment

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

Thank you @nanorepublica ⭐

@sarahboyce sarahboyce merged commit 3ee4c6a into django:main Dec 18, 2024
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carltongibson carltongibson carltongibson approved these changes

@timgraham timgraham timgraham left review comments

@sarahboyce sarahboyce sarahboyce approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nanorepublica @carltongibson @timgraham @sarahboyce