Opened 11 years ago
Closed 10 years ago
#25 closed task (wontfix)
specdomain: allow section headings inside macro declaration docstrings?
Reported by: | cschlep | Owned by: | jemian |
---|---|---|---|
Priority: | trivial | Milestone: | |
Keywords: | specdomain | Cc: |
Description
Do we want to allow section headings inside macro declaration docstrings?
This is a question open to debate. I had this on my wish list initially, but after browsing different projects using sphinx, I believe that this is not a good idea, and definitely goes against the usual practice for other projects.
Using definition lists, one can come up with a clean structure for documentation inside the definition blocks without the need for section headings.
Change History (2)
comment:1 Changed 10 years ago by cschlep
comment:2 Changed 10 years ago by cschlep
- Resolution set to wontfix
- Status changed from new to closed
- Type changed from enhancement to task
Note: See
TracTickets for help on using
tickets.
We've definitely decidede against section headers in macro definition docstrings. Closed ticket.