diff --git a/docs/attributes.rst b/docs/attributes.rst index 139d75c4d4..c2c13a5fcf 100644 --- a/docs/attributes.rst +++ b/docs/attributes.rst @@ -1,7 +1,7 @@ Attributes ---------- -To directly add DOT_ ``att_stmt`` attribute statements, +To directly add DOT_ ``att_stmt`` attribute statements, call the :meth:`~.Graph.attr` method of the :class:`.Graph` or :class:`.Digraph` instance with the wanted target as first argument and the attributes as keyword args. diff --git a/docs/basic_usage.rst b/docs/basic_usage.rst index e3e7e7bbb3..aac2976f2b 100644 --- a/docs/basic_usage.rst +++ b/docs/basic_usage.rst @@ -63,7 +63,7 @@ Check the generated DOT source code: Use the :meth:`~.Graph.render` method to save the DOT source code and render it with the default ``dot`` `layout engine `_ -(see :ref:`below ` for using other layout engines). +(see :ref:`below ` for using other layout engines). .. doctest:: @@ -97,4 +97,4 @@ for the rendered file type. If you need to render arbitrary strings literally (e.g. from user input), consider wrapping them with the :func:`graphviz.escape` function first. See the sections on :ref:`backslash-escapes` - and :ref:`quoting-and-html-like-labels` below for details. \ No newline at end of file + and :ref:`quoting-and-html-like-labels` below for details. diff --git a/docs/development.rst b/docs/development.rst index 374202dbc7..b1a4323d29 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -37,7 +37,7 @@ Install in a venv_ in development mode (includes all ``extras_require``): .. hint:: - alteratively: ``pip install -e .[dev,test,docs]`` + alternatively: ``pip install -e .[dev,test,docs]`` (same as ``pip install -r requirements.txt``) @@ -120,7 +120,7 @@ Use ``help()`` in the REPL to shows/structure methods and attributes in dependen In the above, cooperative multiple inheritance classes reveal their (diamond) MRO structure and methods are shown in **method resolution order** (MRO), which should be an extension of their dependency relation... - + TLDR; you might find this presentation helps to follow the implementation. diff --git a/docs/escapes.rst b/docs/escapes.rst index dff51cacbe..e59efb9123 100644 --- a/docs/escapes.rst +++ b/docs/escapes.rst @@ -7,7 +7,7 @@ The Graphviz_ layout `engines `_ support a number of *centered*, *left*-justified, *right*-justified) and ``\N``, ``\G``, ``\L`` (expanded to the current *node* name, *graph* name, object *label*). -To be able to use them from this library (e.g. for labels), +To be able to use them from this library (e.g., for labels), backslashes in strings are (mostly) passed on **as is**. .. attention:: diff --git a/docs/examples.rst b/docs/examples.rst index 0468f5a31c..ff22716109 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -6,7 +6,7 @@ Examples .. tip:: The following code examples are included in the ``examples/`` directory of the - `source repository/distribution `_. + `source repository/distribution `_. .. note:: @@ -16,7 +16,7 @@ Examples .. include:: _links.rst -hello.py +hello.py -------- .. literalinclude:: ../examples/hello.py diff --git a/docs/existing_files.rst b/docs/existing_files.rst index 94deea680a..722b34a659 100644 --- a/docs/existing_files.rst +++ b/docs/existing_files.rst @@ -2,7 +2,7 @@ Existing files -------------- To directly render an existing DOT_ source file (e.g. created with other tools), -you can use the :func:`graphviz.render` function. +you can use the :func:`graphviz.render` function. .. doctest:: @@ -43,7 +43,7 @@ Call ``.save(skip_existing=False)`` if you want to re-write the loaded source. :meth:`.Source.save`, :meth:`.Source.render`, and :meth:`.Source.view`, wrote the content read into source back into the file. It was advised to use :func:`graphviz.render` and :func:`graphviz.view` - to directly work on files if the superflous saving needed to be avoided. + to directly work on files if the superfluous saving needed to be avoided. .. include:: _links.rst diff --git a/docs/formats.rst b/docs/formats.rst index 4719ab5005..a1e7891e39 100644 --- a/docs/formats.rst +++ b/docs/formats.rst @@ -2,7 +2,7 @@ Formats ------- To use a different `output file format `_ than the default PDF, -you canuse the ``format`` argument when creating your :class:`.Graph` +you can use the ``format`` argument when creating your :class:`.Graph` or :class:`.Digraph` object: .. doctest:: diff --git a/docs/integration_with_viewers.rst b/docs/integration_with_viewers.rst index a941ff0a14..9f7417ef2c 100644 --- a/docs/integration_with_viewers.rst +++ b/docs/integration_with_viewers.rst @@ -2,7 +2,7 @@ Integration with viewers ------------------------ On platforms such as Windows, viewer programs opened by :meth:`~.Graph.render` -with ``view=True`` (or eqivalently with the :meth:`~.Graph.view` shortcut-method) +with ``view=True`` (or equivalently with the :meth:`~.Graph.view` shortcut-method) might **lock** the (PDF, PNG, etc.) file for as long as the viewer is open (blocking re-rendering it with a ``Permission denied`` error). @@ -37,7 +37,7 @@ Other options: - use a viewer that `support live updates `_ -- use the `Jupyter notebook`_ or `Qt Console `_ +- use the `Jupyter notebook`_ or `Qt Console `_ (display the current version of the rendered graph in repeated add/render/view cycles) diff --git a/docs/piped_output.rst b/docs/piped_output.rst index c31d2e812d..b9e1a2a8e3 100644 --- a/docs/piped_output.rst +++ b/docs/piped_output.rst @@ -33,7 +33,7 @@ of your :class:`.Graph` or :class:`.Digraph` object: Because :meth:`~.Graph.pipe` returns the raw ``stdout`` from the layout subprocess by default (:class:`bytes`), you usually want to decode the return value - when piping into formats like ``'svg'`` or ``'plain'``, + when piping into formats like ``'svg'`` or ``'plain'``, .. caution:: diff --git a/docs/styling.rst b/docs/styling.rst index c23a277568..913db62e8b 100644 --- a/docs/styling.rst +++ b/docs/styling.rst @@ -2,7 +2,7 @@ Styling ------- Use the ``graph_attr``, ``node_attr``, and ``edge_attr`` arguments -of the :class:`.Graph` and :class:`.Digraph` constuctors to change +of the :class:`.Graph` and :class:`.Digraph` constructors to change the default `attributes `_ for your graph, nodes, and edges. .. doctest:: diff --git a/docs/unflatten.rst b/docs/unflatten.rst index 18b0f61024..485078214b 100644 --- a/docs/unflatten.rst +++ b/docs/unflatten.rst @@ -1,7 +1,7 @@ Unflatten --------- -To prepocess the DOT_ source of a :class:`.Graph` or :class:`.Digraph` with +To prerpocess the DOT_ source of a :class:`.Graph` or :class:`.Digraph` with the `unflatten `_ preprocessor (`manpage `_, `PDF `_), use the :meth:`~.Graph.unflatten` method.