From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9DEDC43279; Fri, 3 Nov 2023 14:29:26 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 24C474027F; Fri, 3 Nov 2023 14:29:26 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.20]) by mails.dpdk.org (Postfix) with ESMTP id 57D1F40273 for <dev@dpdk.org>; Fri, 3 Nov 2023 14:29:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1699018163; x=1730554163; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=BXVdmDTV9zVHV5QQfkC3r6GNFs+OV2d+vmxQzBESBEM=; b=Pmor1XonfZrohqgCdsNJmqrjx68V8ZgzNKPz6maHovwzRir9tQ0m8A4M 4VIudjn49uZI1oPARtg7bpgzrpo+9bvcZGBEjKpY4gp9HC7wbY8kG13DU Ofx5kqG8syLMztu5erBC2mdr+Lzm42ZXkrbGR4i3Vo4WVJnGsto6Dru6I pYGReklTjvwIrsXKIPJLQ0HWvu3B8UFEoIi9zSbr2gHqKaR++f8yIIAZG avfFunqIdABVhiokV4MDgRAj7GDBMxohbk69s3lTCy6dYukRyhMi8MXuu qI+N5cWEzxcPOyBUVYEHXMi/wPbrQg627LeFTK4gDe4WJSOWJsasi8GAs w==; X-IronPort-AV: E=McAfee;i="6600,9927,10883"; a="379343503" X-IronPort-AV: E=Sophos;i="6.03,273,1694761200"; d="scan'208";a="379343503" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2023 06:29:21 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10883"; a="755157635" X-IronPort-AV: E=Sophos;i="6.03,273,1694761200"; d="scan'208";a="755157635" Received: from unknown (HELO silpixa00401385.ir.intel.com) ([10.237.214.41]) by orsmga007.jf.intel.com with ESMTP; 03 Nov 2023 06:29:21 -0700 From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: Bruce Richardson <bruce.richardson@intel.com> Subject: [PATCH] doc/contributing: update RST text-wrapping guidelines Date: Fri, 3 Nov 2023 13:29:10 +0000 Message-Id: <20231103132910.88333-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Update and clarify the guidelines on how to wrap lines in our RST docs. We no longer limit lines to just 80 characters, and what is more important that line length is the wrapping of sentences, starting a new sentence on a new line, and wrapping at punctuation. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> --- doc/guides/contributing/documentation.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index 4eb62fc36a..9c90efb4ac 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -234,12 +234,18 @@ The most common guidelines for writing RST text are detailed in the The additional guidelines below reiterate or expand upon those guidelines. -Line Length -~~~~~~~~~~~ +Line Length and Wrapping +~~~~~~~~~~~~~~~~~~~~~~~~ -* Lines in sentences should be less than 80 characters and wrapped at - words. Multiple sentences which are not separated by a blank line are joined - automatically into paragraphs. +* Documentation lines should be less than 100 characters. + +* Each sentence should start on a new line. + Multiple sentences, which are not separated by a blank line, + are joined automatically into paragraphs. + +* Wrap sentences at punctuation points, for example, at a comma. + If no punctuation, put the newline at a logical point in the sentence, + for example, at the end of a clause before an "and" or "but". * Lines in literal blocks should be less than 80 characters since they are not wrapped by the document formatters. -- 2.39.2