Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nvictus committed Feb 13, 2024
1 parent 64039f4 commit a3aeee6
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Release Notes

What's changed:

* The deprecated module-level `minpq` and `maxpq` have been removed in favor of same-named classmethods introduced in v1.3.0 (#24)
* Introduce a distinct `Empty` exception for operations that attempt to remove items from an empty pqdict, instead of raising a `KeyError`. (Note that `Empty` is derived from `KeyError` for subclass compatibility with `Mapping.popitem` and `Mapping.clear`.) (#24)
* The deprecated module-level ``minpq`` and ``maxpq`` have been removed in favor of same-named classmethods introduced in v1.3.0 (#24)
* Introduce a distinct ``Empty`` exception for operations that attempt to remove items from an empty pqdict, instead of raising a ``KeyError``. (Note that ``Empty`` is derived from ``KeyError`` for subclass compatibility with ``Mapping.popitem`` and ``Mapping.clear``.) (#24)
* Make internal heap nodes immutable and fast copy as originally proposed by @palkeo in #14

Maintenance:
Expand Down
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@
"sphinx.ext.napoleon",
]

# https://sphinx-themes.org/sample-sites/sphinx-rtd-theme/kitchen-sink/api/
# Automatically extract typehints when specified and place them in
# descriptions of the relevant function/method.
autodoc_typehints = "description"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down
2 changes: 1 addition & 1 deletion docs/pqdict.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ pqdict class

* Remove the top item and return its **key**.
* If the pqdict is empty, return ``default`` if provided, otherwise
raise a ``KeyError``.
raise ``Empty``.

.. automethod:: popvalue

Expand Down
2 changes: 1 addition & 1 deletion pqdict/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ def __init__(
key: Optional[PrioKeyFn] = None,
reverse: bool = False,
precedes: PrecedesFn = lt,
) -> None:
):
"""Create a new priority queue dictionary.
Parameters
Expand Down

0 comments on commit a3aeee6

Please sign in to comment.