From: armando-migliaccio Date: Mon, 28 Sep 2015 18:28:32 +0000 (-0700) Subject: Adding trailing underscores to devref links X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=d9e9a64e5689160e00485415cf578718e09813be;p=openstack-build%2Fneutron-build.git Adding trailing underscores to devref links These were missed and it led to bad rendering. Change-Id: If2ae0e542b16d9c82cbbdcb854b8b3612f64199a --- diff --git a/doc/source/devref/effective_neutron.rst b/doc/source/devref/effective_neutron.rst index a0b739e69..53e963368 100644 --- a/doc/source/devref/effective_neutron.rst +++ b/doc/source/devref/effective_neutron.rst @@ -38,9 +38,9 @@ tests, and so on and so forth...in a nutshell, how to become an effective Neutro developer. The notes below are meant to be free-form and brief by design. They are not meant -to replace or duplicate `OpenStack documentation `, -or any project-wide documentation initiative like `peer-review notes ` -or the `team guide `. For this +to replace or duplicate `OpenStack documentation `_, +or any project-wide documentation initiative like `peer-review notes `_ +or the `team guide `_. For this reason, references are acceptable and should be favored, if the shortcut is deemed useful to expand on the distilled information. We will try to keep these notes tidy by breaking them down into sections if it @@ -128,7 +128,7 @@ Document common nits and pedantic comments to watch out for. clarify a review issue. This speeds up the feeback loop. * The odd pep8 error may cause an entire CI run to be wasted. Consider running validation (pep8 and/or tests) before submitting your patch. If you keep forgetting - consider installing a git `hook ` + consider installing a git `hook `_ so that Git will do it for you. Reviewer comments @@ -148,7 +148,7 @@ Commit messages ~~~~~~~~~~~~~~~ Document common pitfalls as well as good practices done when writing commit messages. -For more details see `Git commit message best practices ` +* When you submit a patch, consider checking its `status `_ in the queue. If you see a job failures, you might as well save time and try to figure out in advance why it is failing. * Excessive use of 'recheck' to get test to pass is discouraged. Please examine the logs for