New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[MRG] [DOC] File-set tutorial styling suggestions #1764
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1764 +/- ##
==========================================
+ Coverage 97.41% 97.43% +0.01%
==========================================
Files 66 66
Lines 10837 10837
==========================================
+ Hits 10557 10559 +2
+ Misses 280 278 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
doc/tutorials/filesets.rst
Outdated
@@ -262,9 +262,9 @@ This includes changes such as: | |||
|
|||
* Adding SOP instances using the :meth:`FileSet.add() | |||
<pydicom.fileset.FileSet.add>` or :meth:`FileSet.add_custom() | |||
<pydicom.fileset.FileSet.add_custom>` methods | |||
<pydicom.fileset.FileSet.add_custom>` methods. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think no period is needed in such lists, if the list item is not a sentence (I'm not a native speaker, so I may be wrong).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tend to agree, in bullet or point form lists usually a period is not needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mrbean-bremen @darcymason that's correct (according to the internet); however, the style should be consistent within a single list (ref). I added these periods here to conform with the next two items.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case I suggest to remove the periods in these two items, otherwise this just looks wrong to me.
Minor styling suggestions to the DICOM File-sets and DICOMDIR tutorial.