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

Feat exclude feature ids #86

Merged
merged 4 commits into from
Aug 8, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
docs(config-file): add note about whitespace-delimited dictionary inp…
…ut in YAML
aleaf committed Aug 6, 2024
commit 61f90d67107b07ffe7d45927533cbc0cbca682bd
17 changes: 17 additions & 0 deletions docs/source/config-file.rst
Original file line number Diff line number Diff line change
@@ -143,8 +143,25 @@ Some additional notes on YAML
* ``[12,1.2]`` parses to ``[12,1.2]``
* ``(12,1.2)`` parses to ``"(12,1.2)"``
* ``{12,1.2}`` parses to ``{12: None, 1.2: None}``
* dictionaries can be represented with indentation, but spaces are needed after the colon(s):

.. code-block:: yaml

items:
0:1
1:2

parses to ``'0:1 1:2'``

.. code-block:: yaml

items:
0: 1
1: 2

parses to ``{0:1, 1:2}``

Using a YAML-aware text editor such as VS Code can help with these issues, for example by changing the highlighting color to indicate a string in the first dictionary example above and an interpreted python data structure in the second dictionary example.

.. _JSON: https://www.json.org/json-en.html
.. _pyyaml: https://pyyaml.org/