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

Built-in methods/classes/functions lack documentation. #2680

Open
DimitrisJim opened this issue May 30, 2021 · 3 comments
Open

Built-in methods/classes/functions lack documentation. #2680

DimitrisJim opened this issue May 30, 2021 · 3 comments
Assignees
Labels
good first issue

Comments

@DimitrisJim
Copy link

@DimitrisJim DimitrisJim commented May 30, 2021

Most (?) of the built in functionality currently lacks corresponding documentation. The functionality to grab and attach the docs is there, the docs just haven't been added.

This, I believe, could make a good first issue for many people, it just involves taking the documentation and adding it before (after works too but most current examples add it before) the #[py(function/method/class)] attribute. As an example, for list.append one could just add:

/// Append object to the end of the list.
#[pymethod]
pub(crate) fn append(&self, x: PyObjectRef) { ... }

The main built-in classes seem to have documentation for the classes but not for the methods. Builtin modules, I'd assume, probably also have many more cases.

@youknowone youknowone added the good first issue label Aug 4, 2021
@AthulMuralidhar
Copy link

@AthulMuralidhar AthulMuralidhar commented Aug 17, 2021

this seems pretty straightforward. Can i start working on this one? @youknowone @DimitrisJim ?

@DimitrisJim
Copy link
Author

@DimitrisJim DimitrisJim commented Aug 17, 2021

Go ahead @AthulMuralidhar!

@youknowone
Copy link

@youknowone youknowone commented Nov 15, 2021

how about closing this issue by preference for #3101?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue
Projects
None yet
Development

No branches or pull requests

3 participants