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

docs: add jsdoc instead of comments #12269

Merged
merged 1 commit into from
Sep 17, 2018
Merged

docs: add jsdoc instead of comments #12269

merged 1 commit into from
Sep 17, 2018

Conversation

alan-agius4
Copy link
Collaborator

This changes was originally required for the API guardian as it was not liking the comments as they were. But I am going to land it separately.

  • Use jsdocs / tsdocs instead of comments
  • rename file from .d.ts to .ts. This is due that d.ts don't get typechecked because we have skipLibCheck enabled which might result in invalid declarations. Referenced dts files don’t get emitted by tsc, which means there should be a separate build process to copy this dts file to dist. And finally I'd very much like to avoid issues like this Cannot find name 'FileReplacements'. #11294 just because we use d.ts instead of .ts

@alan-agius4 alan-agius4 added the target: major This PR is targeted for the next major release label Sep 14, 2018
@alan-agius4 alan-agius4 added target: major This PR is targeted for the next major release and removed target: major This PR is targeted for the next major release labels Sep 14, 2018
@hansl hansl merged commit 7fee770 into angular:master Sep 17, 2018
@alan-agius4 alan-agius4 deleted the benchmark_docs branch September 22, 2018 06:48
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants