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

✨ NEW: Add fieldlist extension #455

Merged
merged 1 commit into from
Dec 6, 2021
Merged

✨ NEW: Add fieldlist extension #455

merged 1 commit into from
Dec 6, 2021

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Dec 6, 2021

Field lists are mappings from field names to field bodies,
based on the reStructureText syntax.

A prominent use case of field lists is for use in API docstrings, as used in Sphinx's docstring renderers.
This should hopefully pave the way for use with sphinx.ext.autodoc

Field lists are mappings from field names to field bodies,
based on the [reStructureText syntax](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists).

A prominent use case of field lists is for use in API docstrings, as used in [Sphinx's docstring renderers](sphinx:python-domain).
This should hopefully pave the way for use with `sphinx.ext.autodoc`
@codecov
Copy link

codecov bot commented Dec 6, 2021

Codecov Report

Merging #455 (b9730e0) into master (cf18116) will decrease coverage by 0.01%.
The diff coverage is 90.32%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #455      +/-   ##
==========================================
- Coverage   90.86%   90.84%   -0.02%     
==========================================
  Files          16       16              
  Lines        1882     1912      +30     
==========================================
+ Hits         1710     1737      +27     
- Misses        172      175       +3     
Flag Coverage Δ
pytests 90.84% <90.32%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
myst_parser/docutils_renderer.py 92.80% <88.46%> (-0.19%) ⬇️
myst_parser/main.py 87.80% <100.00%> (+0.30%) ⬆️
myst_parser/mocking.py 86.64% <100.00%> (+0.05%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cf18116...b9730e0. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant