Comments (3)
This is linked to parafoxia/analytix#61 (pawamoy responded to that as I was writing this!).
from griffe.
Nice timing haha!
So, for reference (stated in the linked issue):
- recent changes to our Numpydoc parser made it so that prose after sections is not allowed anymore (this makes us more compliant with Numpydoc's official style-guide which does not explicitly allow that)
!!!
and???
blocks are Markdown markup, and therefore what we call prose, and that's why these cannot be parsed after known sections such as Parameters or Returns anymore- instead, users can take advantage of the new parser capabilities, generic admonitions:
!!! note
Hello.
...becomes:
Note
----
Hello.
- finally, note that it is still possible to use Markdown markup in all the other places it was also supported: in section item descriptions, as well as in the non-section body of the docstring:
Summary.
Body. Markup still allowed here:
!!! note
Working.
Parameters
----------
param1
Description of param1.
!!! warning
Warning about param1.
param2
etc.
The new admonitions can use any title, and their kind is inferred from the title (basically slugified title):
-
Note ---- Hello.
gives title=Note, kind=note
-
See also -------- Something.
gives title=See also, kind=see-also
I realize there's no way to specify the kind and title separately. Maybe the logic could be improved here to support things like:
Warning: Pay attention to something
-----------------------------------
Contents.
...giving kind=warning, title=Pay attention to something. @machow what do you think?
from griffe.
I will close this issue but pin it for some time, in case others are impacted by the change.
from griffe.
Related Issues (20)
- bug: Regular classes that inherit dataclass do not get dataclass parameters HOT 1
- bug: A class that derives from a dataclass should be labelled a dataclass HOT 2
- feature: Merge value when attribute is first annotated then assigned
- docs: bad link HOT 2
- feature: Future backward-compatibility warnings
- feature: API checks: diff each sequence/mapping value instead of the whole
- bug: Error reading page: tuple index out of range HOT 3
- feature: API checks: Report new positional-or-keyword parameters inserted before other positional-or-keyword parameters
- feature: Warning/hint for objects coming from siblings/parents/external exposed in __all__
- feature: Format/highlight expressions?
- feature: link to re-export instead of inserting full documentation HOT 4
- bug: when using `import x.y.z as a`, Griffe thinks `a` is an alias for `x`, not `x.y.z` HOT 4
- bug: parsing of annotations placed after parameters section fails HOT 1
- docs: Add an example CI setup HOT 1
- bug: Custom implementation of cached_property results in property being categorized as a "method" instead of a cached property HOT 7
- bug: Google docstrings: no support for non-multiple or non-named values in Yields section HOT 3
- feature: extension(?): relative cross-references in docstrings, but resolved by the handler/extractor HOT 6
- feature: Pre-commit integration HOT 4
- feature: Allow passing multiple args to `Object.has_labels` instead of a set
- feature: Allow passing multiple args to `load_extensions` instead of a list
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from griffe.