PR: Prepare Project for First Release #2
+2,248
−1,035
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR prepares the project for a first release:
colour_clf_io.ExponentStyle
,colour_clf_io.LogStyle
andcolour_clf_io.RangeStyle
enumerations were moved to thecolour_clf_io.values
module.A few notes collected whilst doing this:
colour_clf_io.SOPNode.slope
but we do not set any.colour_clf_io.parsing.child_elements
returningstr
is a major pain for type checking, we should look at a way of making sure that contextually, it only returnslxml.etree._Element | None
. I peppered the code with Pyright pragmas for now.colour_clf_io.ProcessNode.description
be alist[str]
likecolour_clf_io.ProcessList.description
?Preflight
Code Style and Quality
Documentation