Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gboeing committed Dec 17, 2024
1 parent d245013 commit 0ab7f77
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ The OSMnx `Examples Gallery`_ contains tutorials and demonstrations of all these
Configuration
^^^^^^^^^^^^^

You can configure OSMnx using the :code:`settings` module. Here you can adjust logging behavior, caching, server endpoints, and more. You can also configure OSMnx to retrieve historical snapshots of OpenStreetMap data as of a certain date. Read more about the :ref:`settings <osmnx-settings-module>` module.
You can configure OSMnx using the :code:`settings` module. Here you can adjust logging behavior, caching, server endpoints, and more. You can also configure OSMnx to retrieve historical snapshots of OpenStreetMap data as of a certain date.

Read more about the :ref:`settings <osmnx-settings-module>` module in the User Reference.

Geocoding and Querying
^^^^^^^^^^^^^^^^^^^^^^
Expand Down
3 changes: 1 addition & 2 deletions osmnx/convert.py
Original file line number Diff line number Diff line change
Expand Up @@ -384,8 +384,7 @@ def to_undirected(G: nx.MultiDiGraph) -> nx.MultiGraph:
for use with functions/algorithms which only accept a MultiGraph object.
Rather, if you want a fully bidirectional graph (such as for a walking
network), configure the `settings` module's `bidirectional_network_types`
before creating your graph and OSMnx will generate a fully bidirectional
MultiDiGraph.
before creating your graph to generate a fully bidirectional MultiDiGraph.
This function maintains parallel edges only if their geometries differ.
See also `to_digraph` to convert MultiDiGraph to DiGraph.
Expand Down

0 comments on commit 0ab7f77

Please sign in to comment.