Skip to content
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

Merged
merged 2 commits into from Feb 16, 2023

Conversation

ZviBaratz
Copy link
Contributor

Minor styling suggestions to the DICOM File-sets and DICOMDIR tutorial.

@codecov
Copy link

codecov bot commented Feb 15, 2023

Codecov Report

Merging #1764 (9fcddf5) into master (4b217ca) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            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     
Impacted Files Coverage Δ
pydicom/filebase.py 99.19% <0.00%> (+1.61%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@@ -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.
Copy link
Member

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).

Copy link
Member

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

Copy link
Contributor Author

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.

Copy link
Member

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.

@darcymason darcymason merged commit bbd76ff into pydicom:master Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants