Skip to content

Docstrings and type hints for distributions#2599

Merged
Ericgig merged 9 commits into
qutip:masterfrom
MathiB123:distributions
Jan 10, 2025
Merged

Docstrings and type hints for distributions#2599
Ericgig merged 9 commits into
qutip:masterfrom
MathiB123:distributions

Conversation

@MathiB123

@MathiB123 MathiB123 commented Jan 9, 2025

Copy link
Copy Markdown
Contributor

Description
Added docstrings and type hints for functions in distributions.py.

@Ericgig Ericgig left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you add type hints to only the update function?
The __init__ and the visualize are also user facing and would benefit from hints to.

Comment thread qutip/distributions.py

@Ericgig Ericgig left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 87.695%. first build
when pulling 374b7b0 on MathiB123:distributions
into 8cc10ba on qutip:master.

@coveralls

coveralls commented Jan 9, 2025

Copy link
Copy Markdown

Coverage Status

coverage: 87.692%. first build
when pulling 5e5ff0e on MathiB123:distributions
into 8cc10ba on qutip:master.

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 87.695%. first build
when pulling a7f5897 on MathiB123:distributions
into 8cc10ba on qutip:master.

@MathiB123 MathiB123 changed the title Docstrings, typing and guide page for distributions Docstrings and type hints for distributions Jan 9, 2025
@Ericgig Ericgig merged commit d1dda95 into qutip:master Jan 10, 2025
@MathiB123 MathiB123 deleted the distributions branch January 10, 2025 19:24
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.

3 participants