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

Fixed #33163 -- Added example of connection signal handlers in AppConfig.ready() to docs. #14925

Conversation

roxanebellot
Copy link
Contributor

See ticket and forum post

I tried to keep as much as existing naming and formulation as I could.

When it is ok with you, I can also do a French translation

@github-actions
Copy link

github-actions bot commented Oct 2, 2021

Hello @roxanebellot! Thank you for your contribution 💪

As it's your first contribution be sure to check out the patch review checklist.

If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!

If you have any design or process questions then you can ask in the Django forum.

Welcome aboard ⛵️!

Copy link
Member

@felixxm felixxm left a comment

Choose a reason for hiding this comment

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

@roxanebellot Thanks for this patch 👍 I don't think that a separate section is needed. I would add an example to the existing admonition. Please try to avoid unnecessary blank lines.

docs/topics/signals.txt Outdated Show resolved Hide resolved
docs/topics/signals.txt Outdated Show resolved Hide resolved
docs/topics/signals.txt Outdated Show resolved Hide resolved
@roxanebellot roxanebellot force-pushed the docs/where_should_signal_connection_code_live branch from 38305df to 9b217b7 Compare October 9, 2021 15:57
@roxanebellot
Copy link
Contributor Author

Hi !

Thank ou for your interest, blank lines are chopped ✔️

Can you confirm that a subsection is unfit compared to using an admonition ? We would loose the benefit of the anchor and maybe legibility too (it would be a big green zone)

Also, i am having doubts about the title "Where should this code live" but if it's ok with you, it's ok with me.

@felixxm
Copy link
Member

felixxm commented Oct 11, 2021

Can you confirm that a subsection is unfit compared to using an admonition ? We would loose the benefit of the anchor and maybe legibility too (it would be a big green zone)

Yes: "I don't think that a separate section is needed. I would add an example to the existing admonition.". IMO a longer admonition doesn't affect readability.

@roxanebellot roxanebellot force-pushed the docs/where_should_signal_connection_code_live branch 2 times, most recently from 96c252a to 45d6d56 Compare October 14, 2021 17:05
@felixxm felixxm removed the request for review from adamchainz November 17, 2021 08:30
@felixxm felixxm changed the title 33163 : Expand documentation on how to connect signals Fixed #33163 -- Added example of connection signal handlers in AppConfig.ready() to docs. Nov 17, 2021
@felixxm
Copy link
Member

felixxm commented Nov 17, 2021

@roxanebellot Thanks for updates 👍 Welcome aboard ⛵

I pushed small edits.

@felixxm felixxm force-pushed the docs/where_should_signal_connection_code_live branch from 45d6d56 to 2d124f6 Compare November 17, 2021 09:00
@felixxm felixxm removed their request for review November 17, 2021 09:01
@felixxm felixxm merged commit 2d124f6 into django:main Nov 17, 2021
@adamchainz
Copy link
Sponsor Member

Thanks @roxanebellot and @felixxm !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants