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

Support for large markdown blocks before and after functions #26

Open
fabienb4 opened this issue Nov 13, 2015 · 0 comments
Open

Support for large markdown blocks before and after functions #26

fabienb4 opened this issue Nov 13, 2015 · 0 comments

Comments

@fabienb4
Copy link
Owner

We need a way to add markdown blocks before and after functions docs like on meteor publish. @before and @after are nice for small things like titles or notes, but large amount of markdown will make the code painful to read.

A suggestion was to be able to include markdown files for any function requiring more details using something like:

/**
 * @summary Whatever.
 * @partial myfunction.md
 */

Although it would work, I think it will make large projects very hard to maintain, with a bunch of files here and there and their inclusions inside the project's code. See #24.

Any ideas/pull request welcome.

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

Successfully merging a pull request may close this issue.

1 participant