Skip to content

Commit

Permalink
docs: Various minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
funkyfuture committed Sep 16, 2024
1 parent 13b2a5b commit 6679a0e
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ release: tests
hatch build
hatch publish

# build and serve HTML documentation at 0.0.0.0:8000
serve-docs: docs
# watch, build and serve HTML documentation at 0.0.0.0:8000
serve-docs:
hatch run docs:serve

# build and open HTML documentation
Expand Down
4 changes: 2 additions & 2 deletions _delb/xpath/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@

class QueryResults(Sequence["NodeBase"]):
"""
A container that includes the results of a CSS selector or XPath query with some
helpers for better readable Python expressions.
A container with the the results of a CSS selector or XPath query with some helpers
for better readable Python expressions.
"""

def __init__(self, results: Iterable[NodeBase]):
Expand Down
4 changes: 2 additions & 2 deletions _delb/xpath/ast.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def nested_repr(obj: Any) -> str: # pragma: no cover

class EvaluationContext(NamedTuple):
"""
Instances of this type are passed to XPath functions in order to pass contextual
Instances of this class are passed to XPath functions in order to pass contextual
information.
"""

Expand All @@ -118,7 +118,7 @@ class EvaluationContext(NamedTuple):
order of the step's axis' direction. The first position is 1.
"""
size: int
""" The number of all nodes all nodes that matched a location step's node test. """
""" The number of all nodes that matched a location step's node test. """
namespaces: Namespaces
""" A mapping of prefixes to namespaces that is used in the whole evaluation. """

Expand Down
2 changes: 1 addition & 1 deletion docs/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ What are your long-term goals with this project?


Interesting Resources
=====================
---------------------

- `The Annotated XML Specification <https://www.xml.com/axml/axml.html>`_ by
co-editor Tim Bray gives cultural, historical and technical insights from a
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ detached = true
dependencies = [
"autodocsumm",
"furo",
"sphinx-autobuild",
"sphinx-copybutton",
"sphinx-design"
]
Expand All @@ -141,7 +142,7 @@ build-html = "make -C docs html"
clean = "make -C docs clean"
doctest = "make -C docs doctest"
linkcheck = "make -C docs linkcheck"
serve = "python -m http.server --directory docs/build/html/"
serve = "sphinx-autobuild --open-browser --delay 2 --watch _delb --watch delb docs docs/build/html/"

[tool.hatch.envs.linting]
dependencies = [
Expand Down

0 comments on commit 6679a0e

Please sign in to comment.