Skip to content

Enhancement: <title> Docs Recommended Example #2654

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

Closed
reda929 opened this issue Nov 8, 2024 · 1 comment
Closed

Enhancement: <title> Docs Recommended Example #2654

reda929 opened this issue Nov 8, 2024 · 1 comment
Labels
enhancement This is an improvement to existing code or configuration

Comments

@reda929
Copy link

reda929 commented Nov 8, 2024

Is your feature request related to a problem? Please describe.

A feature; not an issue.

Describe the solution you'd like

As an ever learning lad, and despite how amazing docs examples are, I still find it very useful to type my own examples to learn the language. While one still has to play around with the concepts, I find it very useful for the page to have a "user' fav example" listed beside the official doc example. Legally, ofc, Python organization is not responsible for any listed code snippets, whether harmful, incorrect or even misleading, but taking users' good intentions as an assumption, there may be a use for letting users recommend what they find best demonstrates the concept best. And after long enough revision by Python org, those revised snippets might be even encompassed as The Example if it meets all criteria. Soon, those snippets will converge to a homogeneous coding style it might not be possible to discern whether they were submitted by different users as the community converges on its preferred coding style from different doc pages.

Basic Example

It would be most likely a folded section underneath official doc example.

Describe alternatives you've considered

No response

Drawbacks and Impact

Python org might prefer to assign a team or a large community, still moderated, to moderate those submissions in case they were suspicious about any submission, and review it before it even surfaces to the webpage.

Additional context

No response

@reda929 reda929 added the enhancement This is an improvement to existing code or configuration label Nov 8, 2024
@merwok
Copy link
Member

merwok commented Apr 23, 2025

Hello! I thinks this has been discussed on python forums (discuss.python.org) before, with comparison to PHP docs as an example.

Personally I think that the Python docs have a different philosophy, and that there isn’t energy to review and maintain user-submitted examples. We have forums (python & other sites), PyMotW, blogs… Examples can be found in many places.

Process note: This website tracker is not meant for these discussions. You can close your ticket and look in the forums.

@hugovk hugovk closed this as not planned Won't fix, can't repro, duplicate, stale Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is an improvement to existing code or configuration
Projects
None yet
Development

No branches or pull requests

3 participants