Skip to content

Remove SOPClass "copy" methods from docs, add notes#385

Merged
CPBridge merged 1 commit into
masterfrom
bug/sopclass_docstrings
Dec 27, 2025
Merged

Remove SOPClass "copy" methods from docs, add notes#385
CPBridge merged 1 commit into
masterfrom
bug/sopclass_docstrings

Conversation

@CPBridge
Copy link
Copy Markdown
Collaborator

The two "copy" method on the SOPClass class (copy_patient_and_study_information and copy_specimen_information) should really be considered "private" methods used only by those writing sub-classes of SOPClass. However currently they appear as methods on all sub-classes, which is confusing and at least some people are using it when they shouldn't (e.g. #384 ).

Since they date back to the beginning of the library, we will wait for a major version to make them truly private. In the meantime, this PR:

  • Removes them from the sphinx documentation
  • Adds a note to the docstrings make it clear how it is expected that they be used.

@CPBridge CPBridge merged commit cc7a254 into master Dec 27, 2025
9 checks passed
@CPBridge CPBridge deleted the bug/sopclass_docstrings branch January 23, 2026 18:50
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.

1 participant