Hi John, On Mon, Dec 19, 2016 at 10:45:32AM +0000, Mcnamara, John wrote: > > -----Original Message----- > > From: dev [mailto:dev-boun...@dpdk.org] On Behalf Of Adrien Mazarguil > > Sent: Friday, December 16, 2016 4:25 PM > > To: dev@dpdk.org > > Subject: [dpdk-dev] [PATCH v2 02/25] doc: add rte_flow prog guide > > > > This documentation is based on the latest RFC submission, subsequently > > updated according to feedback from the community. > > Hi, > > Thanks. That is a very good doc. > > A few RST comments. > > Section headers should use the use the following underline formats: > > Level 1 Heading > =============== > > > Level 2 Heading > --------------- > > > Level 3 Heading > ~~~~~~~~~~~~~~~ > > > Level 4 Heading > ^^^^^^^^^^^^^^^ > > See: http://dpdk.org/doc/guides/contributing/documentation.html#rst-guidelines
OK, although I do not see any mistake regarding this? > Also, some of the section headers for Attributes, Patterns, Match and Action > are a bit short and it isn't clear what section you are in, especially in the > PDF doc. It might be clearer to add the section name before each item like: > > > Attribute: Group > ~~~~~~~~~~~~~~~~ > > Match: VOID > ~~~~~~~~~~~ > > > Tables should have a reference link and a caption, like this: > > .. _table_qos_pipes: > > .. table:: Sample configuration for QOS pipes. > > +----------+----------+----------+ > | Header 1 | Header 2 | Header 3 | > | | | | > +==========+==========+==========+ > | Text | Text | Text | > +----------+----------+----------+ > | ... | ... | ... | > +----------+----------+----------+ > > > See: http://dpdk.org/doc/guides/contributing/documentation.html#tables > > This will make the tables clearer when there are several in a row and will > allow > the text to refer to them with :numref:. > > Also, there is one typo: > > s/unpractically/impractically/ > > > Otherwise, very good work. A good clear document. Thanks, I will fix these and re-submit. -- Adrien Mazarguil 6WIND
