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.

Sign up for GitHub

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

Jump to bottom

[FEAT] Process API doc descriptions with markdown #2958

Closed
griest024 opened this issue Aug 8, 2024 · 0 comments · Fixed by #2961
Closed

[FEAT] Process API doc descriptions with markdown #2958

griest024 opened this issue Aug 8, 2024 · 0 comments · Fixed by #2961
Assignees
@griest024
Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni

Comments

@griest024
Copy link
Member

💡 Feature request

Feature Name

Process API doc descriptions with markdown

The Desired Behavior

I want the descriptions of API docs to be run through the dgeni markdown processor.

Your Use Case

As a daffodil dev, I'd like to be able to write markdown in API docs.

Prior Work

This should close #1798 and #1800
@griest024 griest024 added feat a new feature, enhancement, or improvement docs This issue is related to documentation package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni labels Aug 8, 2024
@griest024 griest024 self-assigned this Aug 8, 2024
@griest024 griest024 mentioned this issue Aug 8, 2024
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@griest024 griest024

Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement package: daff.io @daffodil/daff.io tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(dgeni): process API doc descriptions through markdown griest024/daffodil
1 participant
@griest024