Skip to content

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

Closed

Description

@DimitrisJim

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.

Activity

  1. AthulMuralidhar commented on Aug 17, 2021

    @AthulMuralidhar

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

  2. DimitrisJim commented on Aug 17, 2021

    @DimitrisJim
    MemberAuthor
  3. youknowone commented on Nov 15, 2021

    @youknowone
    Member

    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

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions