[doc] Update cookbook example for socket-based logging in a production sett… (GH-98922) #98922
Conversation
There was a problem hiding this comment.
Looks good overall, just some minor syntax and textual suggestions, and one higher-level comment:
Now that these files are an integral part of the recipe here, maybe better to just host them here alongside it rather than in a personal account on an external site, and provide a direct download link (using :download:)?
Co-authored-by: C.A.M. Gerlach <[email protected]>
|
Thanks @slateny and @CAM-Gerlach for your feedback. I've updated the PR in line with your suggestions.
I did think about that, but I'm not sure there's a precedent for hosting a mini-project like this in the documentation. I didn't want to inline these files in the documentation because of (a) the length of some of them and (b) it's easier to download them all in one ZIP from the Gist, for those who want to try them out and maybe change some things. And since Gists are a part of GitHub, I didn't think of it as an external site. It is a personal account, of course - I don't know if organization-level Gists are a thing. |
There was a problem hiding this comment.
Looking good; I just made suggestions to single-source the long Gist URL instead of maintaining it multiple places embedded in the text, making it easier to update and harder to get out of sync (plus being less disruptive of source text flow). I also fixed a typo'd comma left by one of my previous suggestions. Other than that, LGTM!
|
@vsajip I see, that makes sense. It still feels a bit odd for a section of the doc to essentially be documentation for an external demo project, but it is a cookbook after all and its not like they come with the ingredients included 😄 |
Co-authored-by: C.A.M. Gerlach <[email protected]>
vsajip
changed the title
vsajip
added
needs backport to 3.10
|
Thanks @vsajip for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11. |
|
Thanks @vsajip for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10. |
…n sett… (pythonGH-98922) (cherry picked from commit 50a9b03) Co-authored-by: Vinay Sajip <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
|
GH-98980 is a backport of this pull request to the 3.11 branch. |
…n sett… (pythonGH-98922) (cherry picked from commit 50a9b03) Co-authored-by: Vinay Sajip <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
|
GH-98981 is a backport of this pull request to the 3.10 branch. |
…oduction sett… (GH-98922) (GH-98980) Co-authored-by: Vinay Sajip <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
…oduction sett… (GH-98922) (GH-98981) Co-authored-by: Vinay Sajip <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
…ing.