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(dgeni): add hostDirectives to the API source block #3544

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

feat(dgeni): add hostDirectives to the API source block #3544

wants to merge 2 commits into from

Conversation

griest024
Copy link
Member

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #3500

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@griest024 griest024 added the tools: dgeni @daffodil/tools-dgeni label Mar 6, 2025
@griest024 griest024 requested a review from xelaint March 6, 2025 18:09
@griest024 griest024 requested a review from a team as a code owner March 6, 2025 18:09
@griest024
Copy link
Member Author

@xelaint dgeni does not offer us a good way to editorialize the content of hostDirectives so for now I think we should just display what it gives us. LMK if this is a problem and I can do some messy regex parsing to remove what we don't want.

@xelaint
Copy link
Member

xelaint commented Mar 6, 2025

Can we not retrieve the inputs, their values, and defaults and pass it into the properties table?

@griest024
Copy link
Member Author

Can we not retrieve the inputs, their values, and defaults and pass it into the properties table?

Retrieving the inputs requires regex parsing which becomes very messy, very quickly.

@xelaint xelaint requested a review from damienwebdev March 7, 2025 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xelaint xelaint Awaiting requested review from xelaint

@damienwebdev damienwebdev Awaiting requested review from damienwebdev

At least 1 approving review is required to merge this pull request.

Assignees

@xelaint xelaint

Labels
tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEAT] Inputs from hostDirectives in design components should be included in API docs
2 participants
@griest024 @xelaint