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

Update docstrings #245

Open
wiseodd opened this issue Sep 14, 2024 · 0 comments
Open

Update docstrings #245

wiseodd opened this issue Sep 14, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@wiseodd
Copy link
Collaborator

wiseodd commented Sep 14, 2024

Simplify typehinting

Typehinting in the docstring is redundant.

Before

def f(x: Tensor, n: int = 5) -> Tensor:
    """ Some paragraph.
    
    Parameters
    ----------
    x: Tensor
        Some words.

    n: int, default=5
        Some other words.

After

def f(x: Tensor, n: int = 5) -> Tensor:
    """ Some paragraph.
    
    Parameters
    ----------
    x: Some words.

    n: Some other words. Defaults to `5`.

Add missing docs

There are some of them, e.g. in ParametricLaplace's __init__. Because of this, they're not shown by mkdocstrings.

@wiseodd wiseodd added the documentation Improvements or additions to documentation label Sep 14, 2024
@wiseodd wiseodd self-assigned this Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant