chore(infrastructure): automate method description table in README.md #4873
Conversation
packages/mdc-drawer/README_BASE.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| <!-- %component-foundation-adapter-spacer% --> |
There was a problem hiding this comment.
This README_BASE.md file is copied from drawer/README.md, with the table removed from here.
…/material-components-web into feat/automate-ts-doc
…your changes. Lines starting
|
Ready for rereview |
Codecov Report
@@ Coverage Diff @@
## master #4873 +/- ##
=======================================
Coverage 98.83% 98.83%
=======================================
Files 122 122
Lines 5819 5819
Branches 762 762
=======================================
Hits 5751 5751
Misses 67 67
Partials 1 1
Continue to review full report at Codecov.
|
|
All 699 screenshot tests passed for commit 589fa09 vs. |
|
@abhiomkar ready for re-review! |
|
All 708 screenshot tests passed for commit da11b7c vs. |
|
All 708 screenshot tests passed for commit b1fb723 vs. |
|
All 708 screenshot tests passed for commit 07cc536 vs. |
|
All 708 screenshot tests passed for commit b1d92b1 vs. |
scripts/documentation/tsdoc.ts
Outdated
| .filter((module) => module.methods.length || module.properties.length || module.events.length) | ||
| .sort(this.sortByModuleType); | ||
| const apiMarkdownTable = | ||
| this.templateFunction({modules: componentModules, showFrameworkUsage: true}) + |
There was a problem hiding this comment.
wouldn't it be easier if template function takes all template data it needs at once?
this.templateFunction({
componentModules,
nonComponentModules,
});There was a problem hiding this comment.
Well it is the same template, we'd create another template (partial) to combine these together. I don't think it matters either way works. What would you like?
There was a problem hiding this comment.
I think having a single template as a whole makes it easier to reformat later. The current implementation we are not fully leveraging the use of templating engine, we concat two strings generated separately in the code instead.
There was a problem hiding this comment.
Ok sounds good - i'll make the change.
…d line ripple" This reverts commit 6b0b471.
|
All 708 screenshot tests passed for commit 989fd93 vs. |
|
All 708 screenshot tests passed for commit c031b96 vs. |
…/material-components-web into feat/automate-ts-doc
|
All 708 screenshot tests passed for commit 47a886d vs. |
|
All 708 screenshot tests passed for commit 23dcdcd vs. |
|
All 708 screenshot tests passed for commit 4811deb vs. |
related https://app.zenhub.com/workspaces/mdc-web-585809de72a2830c7f7fbaad/issues/material-components/material-components-web/4858
fixes #4903