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

Standardize comment warning about machine-generated files #7

Open
feep opened this issue Jul 17, 2020 · 1 comment
Open

Standardize comment warning about machine-generated files #7

feep opened this issue Jul 17, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@feep
Copy link
Contributor

feep commented Jul 17, 2020

Qri machine-generates a lot of code, docs...

The heavily-bikeshedded go standard looks good to me.

A standard comment format would be easily greppable and cooperate with existing code tooling like linguist.

Generated files are marked by a line of text that matches the regular expression, in Go syntax:
^// Code generated .* DO NOT EDIT\.$
The .* means the tool can put whatever folderol it wants in there, but the comment must be a single line and must start with Code generated and end with DO NOT EDIT., with a period.

The text may appear anywhere in the file.

@feep
Copy link
Contributor Author

feep commented Jul 18, 2020

This comment should be followed by additional comments specifying:

  • URL of template
  • URL of generation script
  • Regeneration method: Automation URL, or how to manually generate

@feep feep changed the title Standardize comment warning about machine-generated code Standardize comment warning about machine-generated files Jul 18, 2020
@feep feep self-assigned this Jul 18, 2020
@feep feep added the documentation Improvements or additions to documentation label Jul 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant