M2 icon indicating copy to clipboard operation
M2 copied to clipboard

Docstrings before beginDocumentation

Open mahrud opened this issue 1 year ago • 1 comments

People (e.g. https://github.com/Macaulay2/M2/pull/3474) are using somewhat strange techniques to allow documenting methods interspersed in the code.

The benefit of beginDocumentation is that it loads hypertext objects which can be used in document, but technically doc doesn't need any of those. Perhaps we could allow calling doc early and storing the inputs, and once beginDocument is called it should process those early inputs. (Kind of like undocumented' in Core)

mahrud avatar Sep 18 '24 09:09 mahrud

Here's another example: #3862

mahrud avatar Jun 01 '25 15:06 mahrud