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.

Sign up for GitHub

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

Jump to bottom

Add comment to README.md stating that it's auto-generated and shouldn't be edited directly #45

Closed
joshlf opened this issue Oct 11, 2022 · 2 comments
Closed

Add comment to README.md stating that it's auto-generated and shouldn't be edited directly #45

joshlf opened this issue Oct 11, 2022 · 2 comments
Assignees
@varadtote
Labels
experience-easy This issue is easy, and shouldn't require much experience good first issue Good for newcomers

Comments

@joshlf
Copy link
Member

joshlf commented Oct 11, 2022

Update generate-readme.sh to emit a comment following the copyright comment that explains that:

  • README.md is generated automatically
  • Edits should be made in the doc comment on src/lib.rs or in generate-readme.sh
@varadtote
Copy link
Contributor

Can assign ths task to me ?

@joshlf
Copy link
Member Author

joshlf commented Oct 11, 2022

Done!

@joshlf joshlf added experience-easy This issue is easy, and shouldn't require much experience good first issue Good for newcomers labels Oct 15, 2022
@joshlf joshlf closed this as completed in 77e95f0 Oct 21, 2022
joshlf pushed a commit that referenced this issue Aug 3, 2023
@varadtote @joshlf
[README.md] Add "do not edit" comment
f60615d 
Closes #45
@joshlf joshlf mentioned this issue Aug 20, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@varadtote varadtote

Labels
experience-easy This issue is easy, and shouldn't require much experience good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joshlf @varadtote