eipw icon indicating copy to clipboard operation
eipw copied to clipboard

Create lint to detect placeholder text

Open SamWilsn opened this issue 3 years ago • 3 comments

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 https://github.com/ethereum/EIPs/pull/5300#discussion_r926361278

SamWilsn avatar Jul 21 '22 17:07 SamWilsn

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

SamWilsn avatar Jul 29 '22 20:07 SamWilsn

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

MicahZoltu avatar Jul 30 '22 09:07 MicahZoltu

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 avatar Jul 30 '22 14:07 SamWilsn