feat: handle nested submodules #1215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allow users to create documentation for nested modules. Suppose a project has the following submodule structure:
```
my-project
└── foo
└── bar
```
where `foo` and `bar` are submodules. To generate documentation for the `bar` module, call `documentation.toJson('foo.bar')`.
(This is a re-roll of #1190). `jsii-docgen` used to assume that submodules only went one level deep, i.e. that there could not be submodules within submodules. Break that assumption by doing the following: - Use `assembly.allSubmodules` everywhere `assembly.submodules` used to be used. - Address submodules by FQN instead of by `name` (which only holds the last name component). - As an exception: `documentation.toJson()` accepts both FQN as well as root-relative name for backwards compatibility.
otaviomacedo
approved these changes
Nov 21, 2023
rix0rrr
added a commit
to cdklabs/construct-hub
that referenced
this pull request
Nov 21, 2023
Bring in cdklabs/jsii-docgen#1215 which adds support for nested submodules (`asm.sub1.sub2`), and adjust the code to match. Also add S3 throttling protection via retries and backoff, since we have a fair bit of that going around as well.
github-merge-queue bot
pushed a commit
to cdklabs/construct-hub
that referenced
this pull request
Nov 21, 2023
Bring in cdklabs/jsii-docgen#1215 which adds support for nested submodules (`asm.sub1.sub2`), and adjust the code to match. Also add S3 throttling protection via retries and backoff, since we have a fair bit of that going around as well. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(This is a re-roll of #1190).
jsii-docgenused to assume that submodules only went one level deep,i.e. that there could not be submodules within submodules. Break that
assumption by doing the following:
assembly.allSubmoduleseverywhereassembly.submodulesused tobe used.
name(which only holds thelast name component).
documentation.toJson()accepts both FQN as well asroot-relative name for backwards compatibility.