PyYAML documentation fix
A BC <[email protected]> Sun, 24 Sep 2017 13:22:35 +0200
| Newsgroups | gmane.text.yaml.general |
|---|---|
| Message-ID | <CAFsct-ZuXw-sopievLUaj04XfX7B=bmN6ACjUTe6_U7RRSVJ1w@mail.gmail.com> |
Hi,
On http://pyyaml.org/wiki/PyYAMLDocumentation, you find "Feel free to fix
or improve it."
I would like to add the "deep" parameter to the Loader.construct_sequence
and construct_mapping documentation:
- in the {{{ }}} part:
Loader.construct_sequence(node, deep=False)
Loader.construct_mapping(node, deep=False)
- in the text below:
**Loader.construct_sequence(node, deep=False)** checks that the given
node is a sequence and returns a list of Python objects corresponding
to the `node` items. This function is intended to be used in
constructors. Set the `deep` parameter to `True` to recursively
construct subobjects.
**Loader.construct_mapping(node, deep=False)** checks that the given
node is a mapping and returns a dictionary of Python objects
corresponding to the node keys and values. This function is intended
to be used in constructors. Set the `deep` parameter to `True` to
recursively construct subobjects.
Thanks,
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Yaml-core mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/yaml-core