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.

Sign up for GitHub

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 docs #177

Merged
merged 2 commits into from
Oct 19, 2023
Merged

Update docs #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31657d7
fix docstring
rpreen Oct 18, 2023
9482ab5
add inherited members to sphinx docs
rpreen Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions acro/acro_tables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,12 +556,8 @@ def hist( # pylint: disable=too-many-arguments,too-many-locals
'histogram.png' will be used as the filename. A number will be appended automatically
to the filename to avoid overwriting the files.

Returns
-------
matplotlib.Axes

Parameters:
-----------
Parameters
----------
data : DataFrame
The pandas object holding the data.
column : str
Expand Down Expand Up @@ -606,6 +602,10 @@ def hist( # pylint: disable=too-many-arguments,too-many-locals
Whether to show the legend.
filename:
The name of the file where the plot will be saved.

Returns
-------
matplotlib.Axes
"""
logger.debug("hist()")
command: str = utils.get_command("hist()", stack())
Expand Down
1 change: 1 addition & 0 deletions docs/source/acro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ ACRO Class

.. automodule:: acro.acro
:members:
:inherited-members: