-
Notifications
You must be signed in to change notification settings - Fork 185
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
fix(docs:styleguidist): Некостыльный @deprecated
и другие фиксы для стайлгайда
#4701
Conversation
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 72ff830:
|
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## master #4701 +/- ##
==========================================
- Coverage 78.02% 77.99% -0.03%
==========================================
Files 275 275
Lines 8442 8449 +7
Branches 2926 2929 +3
==========================================
+ Hits 6587 6590 +3
- Misses 1855 1859 +4
Flags with carried forward coverage won't be shown. Click here to find out more. see 16 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
👀 Styleguide deployedSee the styleguide for this PR at https://vkcom.github.io/VKUI/pull/4701/ |
c29b635
to
72ff830
Compare
Спасибо @SevereCloud за комментарий, я сходила потыкать эту штуку палкой и поняла, в чем был подвох с парсингом
@deprecated
!propsParser
, чтобы он подхватывал@deprecated
(на проде все и так было почти хорошо),@deprecated
, и обернула его в красивый блок, чтобы не нужно было писать вREADME.md
эту информацию по второму кругу,deprecated.js
🎉tl:dr; при депрекейте компонента достаточно добавить jsdoc-комментарий, ничего ни в какие конфиги больше добавлять не надо, ручками добавлять в
Readme.md
компонента описание а-ля "компонент устарел" тоже.Пример:
Как оно зарендерится
А также:
yarn styleguide:props
), поигралась там с уровнем и текстом, чтобы prettier не добавлял{" "}
и не переносил<code/>
на новую строку