Skip to content

Commit

Permalink
Document the new layout of the output directory in the update section.
Browse files Browse the repository at this point in the history
This patch fixes #115.

The reason we introduced the breaking and compatibility issue described
in this commit, is because we can now give multiple file in "one-shot" to
PyFunceble.
  • Loading branch information
funilrys committed Dec 22, 2020
1 parent 2bed572 commit e76bc51
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/update/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ When you update to PyFunceble :code:`4.0.0`, there will be
- :code:`inactive_db.json`
- :code:`whois_db.json`

- a breaking and compatibility issue if you try to directly (automatically ?)
read the data in the output directory. Indeed if you were looking for
:code:`output/domains/ACTIVE/list` in PyFunceble :code:`3.x`, in :code:`4.0`,
it is now under :code:`output/{{ input_file_name }}/domains/ACTIVE list`.


For development
^^^^^^^^^^^^^^^
Expand Down
5 changes: 5 additions & 0 deletions docs/update/stable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ When you update to PyFunceble :code:`4.0.0`, there will be
- :code:`inactive_db.json`
- :code:`whois_db.json`

- a breaking and compatibility issue if you try to directly (automatically ?)
read the data in the output directory. Indeed if you were looking for
:code:`output/domains/ACTIVE/list` in PyFunceble :code:`3.x`, in :code:`4.0`,
it is now under :code:`output/{{ input_file_name }}/domains/ACTIVE list`.

Using :code:`pip`
^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit e76bc51

Please sign in to comment.