From d57e512f06142163cd0548fb45a4616eb815dcb5 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Mon, 2 Jan 2023 23:00:55 +1000 Subject: [PATCH] doc/start: add Anthony D'Atri's suggestions Add the suggestions made by Anthony D'Atri in https://github.com/ceph/ceph/pull/49609. Signed-off-by: Zac Dover (cherry picked from commit 6141c5f0618432b5dc23d53b5920cab48aa5db7e) --- doc/start/documenting-ceph.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index d0f818efcad1b..93b266d1630c2 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -734,10 +734,10 @@ This is the formula for links to addresses external to the Ceph documentation: Do not fail to include the underscore after the final backtick. - To link to addresses that are external to the Ceph documentation, you have - to include a space between the inline text and the angle bracket that - precedes the external address. This is precisely the opposite of :ref:`the - convention for inline text that links to a location inside the Ceph + To link to addresses that are external to the Ceph documentation, include a + space between the inline text and the angle bracket that precedes the + external address. This is precisely the opposite of :ref:`the convention for + inline text that links to a location inside the Ceph documentation`. If this seems inconsistent and confusing to you, then you're right. It is inconsistent and confusing. @@ -746,10 +746,10 @@ See also ":ref:`External Hyperlink Example`". Internal Links ~~~~~~~~~~~~~~ -To link to a section that is in the Ceph documentation, you must (1) define a -target link before the section and then (2) link to that target from another -location in the documentation. Here are the formulas for targets and links to -those targets: +To link to a section in the Ceph documentation, you must (1) define a target +link before the section and then (2) link to that target from another location +in the documentation. Here are the formulas for targets and links to those +targets: Target:: -- 2.39.5