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

fix: Added support for generating docs for referenced types #1131

Merged
merged 5 commits into from
Dec 19, 2022

Conversation

maschad
Copy link
Contributor

@maschad maschad commented Dec 12, 2022

Closes #1130

@maschad maschad marked this pull request as ready for review December 12, 2022 19:55
@maschad maschad force-pushed the fix/add-support-for-missing-exports branch from 25da4e5 to c490323 Compare December 15, 2022 22:15
@achingbrain achingbrain merged commit 64e04aa into ipfs:master Dec 19, 2022
@achingbrain
Copy link
Member

achingbrain commented Dec 19, 2022

This PR originally had excludeExternals set to true - I couldn't see what it did here so I removed that line.

If it's solving a problem could you please open a new PR that re-enables it and expand the docs tests to show what it's used for and to prevent regressions?

github-actions bot pushed a commit that referenced this pull request Dec 19, 2022
## [37.7.9](v37.7.8...v37.7.9) (2022-12-19)

### Bug Fixes

* Added support for generating docs for referenced types ([#1131](#1131)) ([64e04aa](64e04aa))
@github-actions
Copy link

🎉 This PR is included in version 37.7.9 🎉

The release is available on:

Your semantic-release bot 📦🚀

@maschad
Copy link
Contributor Author

maschad commented Dec 19, 2022

This PR originally had excludeExternals set to true - I couldn't see what it did here so I removed that line.

This was to prevent projects which may reference classes which are built into the language (e.g. HTMLElement), from generating documentation for those references. If that's not a commonality for aegir managed projects then it wouldn't make a difference.

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

Successfully merging this pull request may close these issues.

Docs: Add support for generating docs for internal referenced types
2 participants