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

Create lint to detect placeholder text #22

Open
SamWilsn opened this issue Jul 21, 2022 · 3 comments
Open

Create lint to detect placeholder text #22

SamWilsn opened this issue Jul 21, 2022 · 3 comments
Labels
ready to implement Feature has reached rough consensus among editors and is ready to be implemented

Comments

@SamWilsn
Copy link
Collaborator

Please don't include placeholder text. TBD is appropriate if you don't have any content yet.

cc @SamWilsn we should create a lint rule for people who leave the placeholder text in.

Originally posted by @MicahZoltu in ethereum/EIPs#5300 (comment)

@SamWilsn
Copy link
Collaborator Author

One way to implement this would be to lint for TBD|TODO and put that at the start of each section's placeholder text.

@MicahZoltu
Copy link

What would the advantage of this strategy be vs just doing a string match against the placeholder text itself?

@SamWilsn
Copy link
Collaborator Author

People re-wrap the text all the time, so doing a string match on something long might not always catch it. I guess I could do a whitespace agnostic search too.

A lint to detect TDB and TODO in Review might be useful though.

@SamWilsn SamWilsn added the ready to implement Feature has reached rough consensus among editors and is ready to be implemented label Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to implement Feature has reached rough consensus among editors and is ready to be implemented
Projects
None yet
Development

No branches or pull requests

2 participants