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

Add examples for all Python features in doc #127489

Closed
ArtemIsmagilov opened this issue Dec 1, 2024 · 3 comments
Closed

Add examples for all Python features in doc #127489

ArtemIsmagilov opened this issue Dec 1, 2024 · 3 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@ArtemIsmagilov
Copy link

ArtemIsmagilov commented Dec 1, 2024

Feature or enhancement

Proposal:

Doc text about id func
...
Example

 id("string")
>>>46764578

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

In Rust, all std features have one or more examples.

Please, add in doc 1, 2 examples with code. It's need for simple visualisation, demonstrating features.

hex func have examples, its cool!
https://docs.python.org/3/library/functions.html#hex

But, id func haven't example
https://docs.python.org/3/library/functions.html#id

I think that in general everything that is in Python in the documentation should be with at least one example of how to apply it. Let's take an example from Rust!

This is a big problem, because it is not clear how to apply the language features and in what situation. a small example will give me an idea of how the correct application of features looks like.

@ArtemIsmagilov ArtemIsmagilov added the type-feature A feature request or enhancement label Dec 1, 2024
@tomasr8 tomasr8 added the docs Documentation in the Doc dir label Dec 1, 2024
@AA-Turner
Copy link
Member

This is an existing goal, there exist preliminary efforts to start this with string methods. Closing as duplicate.

A

@AA-Turner AA-Turner closed this as not planned Won't fix, can't repro, duplicate, stale Dec 1, 2024
@tomasr8
Copy link
Member

tomasr8 commented Dec 1, 2024

This is an existing goal, there exist preliminary efforts to start this with string methods. Closing as duplicate.

A

Is there an existing issue that we can link to?

@hugovk
Copy link
Member

hugovk commented Dec 1, 2024

Yes, here's one: #119445

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
Status: Todo
Development

No branches or pull requests

4 participants