Skip to content

Commit

Permalink
Document an example of how to configure import_aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
lieryan committed Jan 30, 2024
1 parent 1667b67 commit 253fdee
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ Will be used if [tool.rope] is configured.
[tool.rope]
split_imports = true
import_aliases = [
['dt', 'datetime'],
['mp', 'multiprocessing'],
]
config.py
---------
Expand Down Expand Up @@ -48,9 +53,9 @@ Additionally, you can run an executable function at startup of rope.
pytool.toml
-----------
If neither a config.py or a pyproject.toml is present, rope will use a pytool.toml.
It follows the exact same syntax of the pyproject.toml.
It follows the exact same syntax as ``pyproject.toml``.

- Mac OS X: ``~/Library/Application Support/pytool.toml.``
- Mac OS X: ``~/Library/Application Support/pytool.toml``.
- Unix: ``~/.config/pytool.toml``` or in $XDG_CONFIG_HOME, if defined
- Windows: ``C:\Users\<username>\AppData\Local\pytool.toml``

Expand Down

0 comments on commit 253fdee

Please sign in to comment.