Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fx readme #82

Merged
merged 2 commits into from
Oct 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ kwargs
- ``hiyapyco.METHOD_MERGE``: perform a deep merge
- ``hiyapyco.METHOD_SUBSTITUTE``: perform a merge w/ lists substituted (unsupported)

- ``mergelists``: boolean try to merge lists of dict (default: ``True``)
- ``mergelists``: boolean try to merge lists of dict (default: ``True``)

- ``none_behavior``: bit (one of the listed below):
- ``none_behavior``: bit (one of the listed below):

- ``hiyapyco.NONE_BEHAVIOR_DEFAULT``: attempt to merge the value with ``None`` and fail if this is not possible (default method)
- ``hiyapyco.NONE_BEHAVIOR_OVERRIDE``: ``None`` always overrides any other value.
Expand All @@ -155,9 +155,9 @@ kwargs
OrderedDict loader/dumper (see: Ordered Dict Yaml Loader / Dumper
aka. ODYLDo) (default: ``False``)

- ``dereferenceyamlanchors``: boolean : dereference yaml anchors and use a copy (default: ``True``)
- ``dereferenceyamlanchors``: boolean : dereference yaml anchors and use a copy (default: ``True``)

- ``encoding``: string : encoding used to read yaml files (default: ``utf-8``)
- ``encoding``: string : encoding used to read yaml files (default: ``utf-8``)

- ``failonmissingfiles``: boolean : fail if a supplied YAML file can
not be found (default: ``True``)
Expand All @@ -176,10 +176,10 @@ kwargs
(see `PR #76 <https://github.com/zerwes/hiyapyco/pull/76>`_.)

- ``loader_callback``: optional custom callback function to load yaml files.
The callback function shall behave like ``yaml.load_all`` from PyYAML,
taking a IO stream as input and returning a list of objects.
Using this method, for example `ruamel <https://pypi.org/project/ruamel.yaml/>`_
can be used instead of PyYAML etc.
The callback function shall behave like ``yaml.load_all`` from PyYAML,
taking a IO stream as input and returning a list of objects.
Using this method, for example `ruamel <https://pypi.org/project/ruamel.yaml/>`_
can be used instead of PyYAML etc.

interpolation
~~~~~~~~~~~~~
Expand Down
Loading