Skip to content

C
Coredns
Commit fb5efa20 authored by Miek Gieben's avatar Miek Gieben Committed by GitHub
Browse files
Options

Add check for Also See for READMEs (#4261) 

Signed-off-by: default avatarMiek Gieben <miek@miek.nl>
parent 8759d00e
Hide whitespace changes
Inline Side-by-side
Showing with 4 additions and 0 deletions
test/readme_test.go
View file @ fb5efa20
...@@ -141,6 +141,10 @@ func sectionsFromReadme(readme string) error { ...@@ -141,6 +141,10 @@ func sectionsFromReadme(readme string) error {
s := bufio.NewScanner(f) s := bufio.NewScanner(f)
for s.Scan() { for s.Scan() {
line := s.Text() line := s.Text()
if strings.HasPrefix(line, "## Also See") {
return fmt.Errorf("Please use %q instead of %q", "See Also", "Also See")
}
switch section { switch section {
case 0: case 0:
if strings.HasPrefix(line, "## Name") { if strings.HasPrefix(line, "## Name") {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment