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

Docstrings before beginDocumentation #3484

Open
mahrud opened this issue Sep 18, 2024 · 0 comments
Open

Docstrings before beginDocumentation #3484

mahrud opened this issue Sep 18, 2024 · 0 comments

Comments

@mahrud
Copy link
Member

mahrud commented Sep 18, 2024

People (e.g. #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 mahrud changed the title Docstrings in the package Docstrings before beginDocumentation Sep 18, 2024
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

No branches or pull requests

1 participant