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 documentation of distribtion class #24

Merged
merged 6 commits into from
Sep 18, 2024

Conversation

marinaevers
Copy link
Collaborator

I added a documentation file explaining the distribution class on a higher level. I also included some information about the currently supported information. This causes some duplicates compared to the usual documentation but should make using the class and the library easier.

The important changes are in the file distribution.rst, the index file only contains a reference.

Closes #17

@marinaevers marinaevers linked an issue Sep 5, 2024 that may be closed by this pull request
each sentence new line (semantic line breaks)
@hageldave
Copy link
Collaborator

looks good. I introduced semantic line breaks [1, 2] for better versioning of natural text.

@hageldave
Copy link
Collaborator

I think we could include a high level doc string into the distribution class too

class Distribution:

we could list the available attributes of the class here.
Something like this:

class Distribution:
    """
    The Distribution class is a wrapper for a variety of probability distributions ...
    
    Attributes:
        name (str): name of the distribution type, e.g. 'Normal'
    ...
    """

@marinaevers marinaevers merged commit d0cb18e into main Sep 18, 2024
@marinaevers marinaevers deleted the 17-good-documentation-of-distribution-class branch September 18, 2024 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Good documentation of distribution class
2 participants