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

Jump to bottom

Minor api docs improvements #16

Merged
merged 5 commits into from
Oct 8, 2021
Merged

Minor api docs improvements #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df050f0
Minor api docs improvements
bwohlberg Sep 28, 2021
91c1f64
Merge branch 'main' into brendt/api-docs
bwohlberg Oct 5, 2021
80ce686
Merge branch 'main' into brendt/api-docs
bwohlberg Oct 5, 2021
2153721
Merge branch 'main' into brendt/api-docs
bwohlberg Oct 6, 2021
dd50243
Merge branch 'main' into brendt/api-docs
lukepfister Oct 8, 2021
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
2 changes: 1 addition & 1 deletion scico/numpy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# user license can be found in the 'LICENSE' file distributed with the
# package.

"""Construct wrapped versions of :mod:`jax.numpy` functions.
"""Wrapped versions of :mod:`jax.numpy` functions.

This modules consists of functions from :mod:`jax.numpy`. Some of these functions are wrapped to support compatibility with :class:`scico.blockarray.BlockArray` and are documented here. The remaining functions are imported directly from :mod:`jax.numpy`. While they can be imported from the :mod:`scico.numpy` namespace, they are not documented here; please consult the documentation for the source module :mod:`jax.numpy`.

Expand Down
12 changes: 12 additions & 0 deletions scico/scipy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
# e -*- coding: utf-8 -*-
# Copyright (C) 2021 by SCICO Developers
# All rights reserved. BSD 3-clause License.
# This file is part of the SCICO package. Details of the copyright and
# user license can be found in the 'LICENSE' file distributed with the
# package.

"""Wrapped versions of :mod:`jax.scipy` functions.

This modules currently serves simply as a namespace for :mod:`scico.scipy.special`.
"""

from . import special
2 changes: 1 addition & 1 deletion scico/scipy/special.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# user license can be found in the 'LICENSE' file distributed with the
# package.

"""Construct wrapped versions of :mod:`jax.scipy.special` functions.
"""Wrapped versions of :mod:`jax.scipy.special` functions.

This modules consists of functions from :mod:`jax.scipy.special`. Some of these functions are wrapped to support compatibility with :class:`scico.blockarray.BlockArray` and are documented here. The remaining functions are imported directly from :mod:`jax.numpy`. While they can be imported from the :mod:`scico.numpy` namespace, they are not documented here; please consult the documentation for the source module :mod:`jax.scipy.special`.
"""
Expand Down