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

[api-documenter] Add do not edit comment #1215

Merged
merged 5 commits into from
Apr 9, 2019

Conversation

rudolf
Copy link
Contributor

@rudolf rudolf commented Apr 8, 2019

Many code bases consist of both written and generated documentation. This PR adds a "Do not edit this file" header similar to https:/Microsoft/web-build-tools/blob/master/apps/api-extractor/src/generators/ReviewFileGenerator.ts#L42

@octogonz
Copy link
Collaborator

octogonz commented Apr 8, 2019

We should make the wording of the message more consistent with the report file message, but otherwise looks good to me

@rudolf
Copy link
Contributor Author

rudolf commented Apr 8, 2019

What about:

Do not edit this file. It is documentation generated by API Documenter.

?

@octogonz
Copy link
Collaborator

octogonz commented Apr 8, 2019

Sure, that's a little more concise. :-)

@octogonz
Copy link
Collaborator

octogonz commented Apr 9, 2019

@skaapgif I fixed the message and removed the hyperlink (since markup isn't really valid inside an HTML comment).

@octogonz octogonz merged commit 66a6e67 into microsoft:master Apr 9, 2019
@octogonz
Copy link
Collaborator

octogonz commented Apr 9, 2019

This fix was published with API Documenter beta release 7.0.49

@rudolf
Copy link
Contributor Author

rudolf commented Apr 9, 2019

Awesome, thanks 👍

@rudolf rudolf deleted the ad-do-not-edit-comment branch April 9, 2019 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants