[WIP] build(aio): test doc comments with latest tags #5
Conversation
This file contains hidden or 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
petebacondarwin
force-pushed
the
aio-jsdoc-tag-structure
branch
from
a0a37e2 to
6d0e882
Compare
This also prevents some extra `<a>` elements inserted by the browser's trying to fix the HTML structure, which also fixes the `.header-link` added in ToC. Fixes angular#22387 Closes angular#22437 PR Close angular#22446
This approach simplifies the styling needed considerably. Previously, we had to make room on the left for heading that are in visual containers. Also we had to apply a `float:right` when on narrow screens as the gutter not available then. This float didn't render nicely if the heading text was longer than could be rendered on a single line. Closes angular#22131
…22400) Previously, when a downgraded component was destroyed in a way that did not trigger the `$destroy` event on the element (e.g. when a parent element was removed from the DOM by Angular, not AngularJS), the `ComponentRef` was not destroyed and unregistered. This commit fixes it by listening for the `$destroy` event on both the element and the scope. Fixes angular#22392 PR Close angular#22400
`ts-api-guardion` has been updated to accept new TypeScript syntax PR Close angular#22402
* The first paragraph is now split off into the `shortDescription` property. * Usage of `howToUse` and `whatItDoes` have been updated. * The "Overview" heading for class is removed as it is self-evident * The original horizontal rule styling below the main heading is removed as not part of the new design Closes angular#22385 PR Close angular#22401
inject() supports the ngInjectableDef-based configuration of the injector (otherwise known as tree-shakeable services). It was missing from the exported API of @angular/core, this PR adds it. The test added here is correct in theory, but may pass accidentally due to the decorator side-effect replacing the inject() call at runtime. An upcoming compiler PR will strip reified decorators from the output entirely. Fixes angular#22388 PR Close angular#22389
We now add the 'main', 'module', 'es2015', and 'typings' properties, pointing to where the packaging tool lays them out. Fixes angular#22416 PR Close angular#22499
jbogarthyde
force-pushed
the
aio-jsdoc-tag-structure
branch
2 times, most recently
from
0e9c8d5 to
6a4ebbe
Compare
"ng update" supports having multiple packages as part of a group which should be updated together, meaning that e.g. calling "ng update @angular/core" would be equivalent to updating all packages of the group (that are part of the package.json already). In order to support the grouping feature, the package.json of the version the user is updating to needs to include an "ng-update" key that points to this metadata. The entire specification for the update workflow can be found here: https://github.com/hansl/devkit/blob/2e8b12a4ef53833dc006e8711acf95cf3a6cf24e/docs/specifications/update.md PR Close angular#22482
The `exampleMap` needs to hold an hash object for each of the `collectExamples.exampleFolders` paths. Previously these hash objects were only created if there was actually an example file the hash's respective example folder. This could cause crashes during `yarn docs-watch` (and so also `yarn sync-and-serve`) if no examples were read in for a particular run of the doc-gen. PR Close angular#22502
…mAlias` (angular#22494) The disambiguation needs to be done earlier so that the auto-link-code post-processor can benefit from it. PR Close angular#22494
The new version of `dgeni-packages/typescript` no longer strips out "namespaces" from types, which was part of the problem of not autolinking correctly to `HttpEventType.Response`. Another part of the problem was that we did not include `.` characters when matching potential code blocks for auto-linking, which precluded properties of enums from being linked. Finally, members we not being given a `path` property, which is needed to effectively autolink to them. This is now set in the `simplifyMemberAnchors` processor. Closes angular#21375 PR Close angular#22494
…okens (angular#22376) Previously the injectable compiler assumed all tree-shakeable injectables would have dependencies that were injectables or InjectionTokens. However old code still uses string tokens (e.g. NgUpgrade and '$injector'). Using such tokens would cause the injectable compiler to crash. Now, the injectable compiler can properly generate a dependency on such a string token. PR Close angular#22376
jbogarthyde
force-pushed
the
aio-jsdoc-tag-structure
branch
from
6a4ebbe to
b05dd55
Compare
petebacondarwin
pushed a commit
that referenced
this pull request
Oct 14, 2020
petebacondarwin
pushed a commit
that referenced
this pull request
Oct 14, 2020
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Changes doc comments in source files to test dgeni tags and rendering
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information