Skip to content

✏️ Update API docs#42

Merged
mbuttner merged 2 commits into
scverse:mainfrom
grst:update-api-docs
Jun 27, 2023
Merged

✏️ Update API docs#42
mbuttner merged 2 commits into
scverse:mainfrom
grst:update-api-docs

Conversation

@grst
Copy link
Copy Markdown
Collaborator

@grst grst commented Jun 26, 2023

Divide API docs into sections and add missing functions

@mbuttner
Copy link
Copy Markdown
Collaborator

There's an incorrect reference in the plotdata documentation. If you have time, it would be great if you can fix it, too.

Comment thread docs/conf.py
html_context["github_repo"] = "pytometry" # noqa
# We're actually using this for the link behind the brand of the page!
html_theme_options["logo"] = {"link": "pytometry"} # noqa
extensions += ["sphinx.ext.intersphinx"]
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

not sure if this is the intended way to make this work with lmdocs?

Comment on lines -53 to -55
to a colormap. For a single-color, transparency-based colormap, see
:func:`alpha_colormap`.
Defaults to 'jet'.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

There's no alpha_colormap in pytometry, nor could I find that function in matplotlib.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

Merging #42 (8368fa1) into main (6b37445) will not change coverage.
The diff coverage is 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff           @@
##             main      #42   +/-   ##
=======================================
  Coverage   80.41%   80.41%           
=======================================
  Files          10       10           
  Lines         388      388           
=======================================
  Hits          312      312           
  Misses         76       76           
Impacted Files Coverage Δ
pytometry/__init__.py 100.00% <ø> (ø)
pytometry/plotting/_scatter_density.py 100.00% <ø> (ø)
pytometry/plotting/_histogram.py 69.56% <100.00%> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@mbuttner mbuttner changed the title Update API docs ✏️ Update API docs Jun 27, 2023
@mbuttner mbuttner merged commit 2c72f48 into scverse:main Jun 27, 2023
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