feat: loose mode to ignore all errors #370
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
iliapolo
commented
Jul 20, 2021
| @@ -10,7 +10,7 @@ const LIBRARIES = `${__dirname}/../../__fixtures__/libraries`; | |||
|
|
|||
| // this is a little concerning...we should be mindful | |||
| // if need to keep increasing this. | |||
| jest.setTimeout(2 * 60 * 1000); | |||
| jest.setTimeout(3 * 60 * 1000); | |||
There was a problem hiding this comment.
The new test I added takes more than 2 minutes... :\
RomainMuller
approved these changes
Jul 20, 2021
eladb
approved these changes
Jul 20, 2021
mergify bot
pushed a commit
that referenced
this pull request
Jul 22, 2021
This PR reverts a previous misguided decision to [ignore](#370) rosetta failures and fallback to typescript assemblies. We decided we never want to show typescript code in the documentation of other languages, a better experience is actually to fail and either introduce more heuristics in rosetta to bypass such failures, or make the necessary adjustments to the published package. In addition, we used to transliterate the entire type-system (i.e all dependent assemblies) and not just the top level assembly. The rational being that code snippets might come from those assemblies when expanding arguments for python docs. Problem is that this means that a transliteration failure in a deeply nested dependency, that most likely doesn't have any affect on the documentation, prevents package transliteration. This can act as a sort of poison pill because many packages depend on the same core libraries. Also, we aren't currently even rendering those code snippets in the docs, so there is no good reason to do it.
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.
Currently the
looseproperty is being used to signal acceptable failures tojsii-rosettaduring the transliteration process.Apparently there are failures which are not covered by setting
loose: truein rosetta.In order to be able to generate API reference even for those types of failures, we broaden the meaning of
loosein the context ofjsii-docgensuch that any transliteration failure will be caught and silently ignored.