diff mbox

[dpdk-dev] doc: fix mistakes in contribution guide

Message ID 1481170768-21700-1-git-send-email-wang.yong19@zte.com.cn (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
checkpatch/checkpatch success coding style OK

Commit Message

Yong Wang Dec. 8, 2016, 4:19 a.m. UTC 
  Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>
---
 doc/guides/contributing/documentation.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

John McNamara Dec. 8, 2016, 9:20 a.m. UTC | #1 
> -----Original Message-----
> From: Yong Wang [mailto:wang.yong19@zte.com.cn]
> Sent: Thursday, December 8, 2016 4:19 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Yong Wang <wang.yong19@zte.com.cn>
> Subject: [PATCH] doc: fix mistakes in contribution guide


Thanks for the fixes. One minor comment below.


> 
> Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>
> ---
>  doc/guides/contributing/documentation.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/contributing/documentation.rst
> b/doc/guides/contributing/documentation.rst
> index 5ec0675..5f16a0c 100644
> --- a/doc/guides/contributing/documentation.rst
> +++ b/doc/guides/contributing/documentation.rst
> @@ -381,9 +381,9 @@ Lists
>       #. Item one.
> 
>       #. Item two is a long line that is wrapped and then indented
> -        to match the start of the e first line.
> +        to match the start of the first line.
> 
> -     #. Item two is a long line that is wrapped and then indented to
> match
> +     #. Item three is a long line that is wrapped and then indented to
> match
>          the start of the previous line.


The middle item should probably be deleted. I would replace the list with the following:

     #. Item one.

     #. Item two is a long line that is wrapped and then indented to match
        the start of the previous line.

     #. Item three.


Thanks,

John
diff mbox

Patch

diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 5ec0675..5f16a0c 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -381,9 +381,9 @@  Lists
      #. Item one.
 
      #. Item two is a long line that is wrapped and then indented
-        to match the start of the e first line.
+        to match the start of the first line.
 
-     #. Item two is a long line that is wrapped and then indented to match
+     #. Item three is a long line that is wrapped and then indented to match
         the start of the previous line.
 
 * Definition lists can be written with or without a bullet::
@@ -477,7 +477,7 @@  Images
 
 * `Inkscape <http://inkscape.org>`_ is the recommended graphics editor for creating the images.
   Use some of the older images in ``doc/guides/prog_guide/img/`` as a template, for example ``mbuf1.svg``
-  or ``ring-enqueue.svg``.
+  or ``ring-enqueue1.svg``.
 
 * The SVG images should include a copyright notice, as an XML comment.