flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From greghogan <...@git.apache.org>
Subject [GitHub] flink pull request #5024: [hotfix][docs] Readme review to clarify heading fo...
Date Tue, 21 Nov 2017 20:02:31 GMT
Github user greghogan commented on a diff in the pull request:

    https://github.com/apache/flink/pull/5024#discussion_r152384103
  
    --- Diff: docs/README.md ---
    @@ -90,7 +90,7 @@ This will be replaced with the value of the variable called `NAME` when
generati
     
     #### Headings
     
    -All documents are structured with headings. From these headings, you can automatically
generate a page table of contents (see below).
    +All documents are structured with headings, written in "Title Case". From these headings,
you can automatically generate a page table of contents (see below).
    --- End diff --
    
    It seems that this could be left as an implicit assumption for "headings".


---

Mime
View raw message