Skip to content

Commit

Permalink
Fix Sphinx nitpicks fron message_ix docs (#506)
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeru authored Jan 11, 2024
1 parent be06f38 commit b7c264a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions RELEASE_NOTES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Migration notes
---------------
Update code that imports from the following modules:

- :py:`ixmp.reporting` → use :py:`ixmp.report`.
- :py:`ixmp.reporting.computations` → use :py:`ixmp.report.operator`.
- :py:`ixmp.utils` → use :py:`ixmp.util`.
- :py:`ixmp.reporting` → use :mod:`ixmp.report`.
- :py:`ixmp.reporting.computations` → use :mod:`ixmp.report.operator`.
- :py:`ixmp.utils` → use :mod:`ixmp.util`.

Code that imports from the old locations will continue to work, but will raise :class:`DeprecationWarning`.

Expand Down
2 changes: 1 addition & 1 deletion ixmp/backend/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@


class ItemType(IntFlag):
"""Type of data items in :class:`.TimeSeries` and :class:`.Scenario`."""
"""Type of data items in :class:`.ixmp.TimeSeries` and :class:`.ixmp.Scenario`."""

# NB the docstring comments ('#:') are placed as they are to ensure the
# output is readable.
Expand Down
2 changes: 1 addition & 1 deletion ixmp/core/timeseries.py
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ def url(self) -> str:
Examples
--------
To form a complete URL (e.g. to use with :meth:`.from_url`), use a configured
:class:`Platform` name:
:class:`.ixmp.Platform` name:
>>> platform_name = "my-ixmp-platform"
>>> mp = Platform(platform_name)
Expand Down
2 changes: 1 addition & 1 deletion ixmp/report/operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ def data_for_quantity(


def from_url(url: str, cls=TimeSeries) -> "TimeSeries":
"""Return a :class:`.TimeSeries` or subclass instance, given its `url`.
"""Return a :class:`.ixmp.TimeSeries` or subclass instance, given its `url`.
Parameters
----------
Expand Down

0 comments on commit b7c264a

Please sign in to comment.