DOC: Fix reStructuredText formatting issues in coding style guideline. #1421
Conversation
|
@jchoude Thanks for reporting the issue ! Rather than checking the GitHub file, it looks like checking the dipy website version gives a more intuitive idea of what's going on. The mission file seems to have issues as well, but it's rendered correctly. Please, correct me if I'm wrong, and if both versions should be rendered correctly. |
Codecov Report
@@ Coverage Diff @@
## master #1421 +/- ##
==========================================
- Coverage 87.39% 87.38% -0.01%
==========================================
Files 237 237
Lines 30069 30069
Branches 3232 3232
==========================================
- Hits 26278 26277 -1
Misses 3043 3043
- Partials 748 749 +1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Thanks for doing this @jhlegarreta !
Can I request some additional change?
doc/devel/coding_style_guideline.rst
Outdated
| object called ``GradientTable`` which holds all the acquisition specific | ||
| parameters, e.g. b-values, b-vectors, timings and others.* | ||
| * Cite the relevant papers. Use the *[NameYear]* convention for | ||
| cross-referencing them, such as in [Garyfaillidis2014]_, and put them |
There was a problem hiding this comment.
Garyfallidisinstead of Garyfaillidis
There was a problem hiding this comment.
Thanks ! I inspected this visually yesterday without being able to tell why it was not being linked 😬
doc/devel/coding_style_guideline.rst
Outdated
| DIPY object, etc.). | ||
| * When referring to relative paths, use the backquote inline markup | ||
| convention, such as in ``doc/devel``. Do not add the | ||
| greater-than/less-than signs to enclose the path. | ||
|
|
||
|
|
||
| """ |
There was a problem hiding this comment.
Do we really need this quotes? I think you can remove them because they look strange as you can see on this page
There was a problem hiding this comment.
I think they make easier reading the text, standing out what is a code snippet or any other construct that belong to the structure of the toolkit. The reason why they are double inverted quotes instead of simple inverted quotes is due to the Sphinx syntax in the docstrings (if I remember well).
A question relative to the way dirs had to be described was raised in a comment #1314 .
There was a problem hiding this comment.
I think we are not talking about the same line. I am talking about the double quotes here, line 113
There was a problem hiding this comment.
OK, now I got it. Sorry. My bad.
doc/devel/coding_style_guideline.rst
Outdated
| @@ -117,4 +123,5 @@ References | |||
| <http://journal.frontiersin.org/Journal/10.3389/fninf.2014.00008/abstract>`_ | |||
| Frontiers in Neuroinformatics, vol.8, no.8. | |||
|
|
|||
| .. include:: ../links_names.inc | |||
| """ | |||
There was a problem hiding this comment.
Same comment as above. The double quotes are not necessary here.
|
Concerning the rendering, I wonder why GitHub does not take in consideration |
jhlegarreta
force-pushed
the
FixCodingStyleGuidelineFormatting
branch
from
bbd4260
to
6ec74bc
Compare
|
Yes, I also realized that GitHub does not link the cross-refs in |
|
It seems that github don't allow the include directive for security reason (look here). |
jhlegarreta
force-pushed
the
FixCodingStyleGuidelineFormatting
branch
from
6ec74bc
to
244a049
Compare
|
OK. Fixed the quotes. Thanks for the explanation on the |
jhlegarreta
force-pushed
the
FixCodingStyleGuidelineFormatting
branch
from
244a049
to
e332c38
Compare
|
Sorry Serge. I missed that in your first comment. Done. |
Fix RST markup issues in the `coding_style_guideline.rst` file. Fixes dipy#1390.
|
Thank you @jhlegarreta, it looks better now after test. merging ! |
…Formatting DOC: Fix reStructuredText formatting issues in coding style guideline.
Fix RST markup issues in the
coding_style_guideline.rstfile.Fixes #1390.