Minor improvements to Scalar class documentation and code#239
Minor improvements to Scalar class documentation and code#239
Conversation
…'other' to reduce potential confusion between the data member 'value' and the formal argument with the same name. Made all arguments in comparison functions positional.
…minate duplicated string constants. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
…cumentation based on failures I was when running 'poetry run python -m doctest src\nitypes\scalar.py -v'. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
…utomated test failure, so I reverted those few changes. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
…h previous documentation heading. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
…e it consistent with other similar sentences. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
…her petty documentation improvements. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
|
Inspired by @bkeryan's statement that equality comparison operators are always supported I decided to split comparison section of the document between equality and order comparison operators. I like new organization better. |
Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
… by a comment from bkeryan. I like this organization better than what we had before. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
|
@bkeryan, I see we use of slightly different terminology and orthography within scalar.py. Some were there before this PR. Here is what I found with the version of the file in this PR:
Would you like me to address this inconsistency as part of this PR? |
…penetrate the arcane error message. Signed-off-by: Kosta Ilic <kosta.ilic@emerson.com>
No, I think this is fine. "object" vs. "class" is intentional. An object is an instance of the class. "class" is a specific "data type". "Scalar" is lowercase in prose and capitalized when referring to the class name. "data object" vs. "object" and "data class" vs. "class" is a minor inconsistency. |
What does this Pull Request accomplish?
This PR resolves issues #230 and #231.
Summary of changes:
Why should this Pull Request be merged?
The changes increase value of the library.
What testing has been done?
I executed prescribed static code and automated test protocols. Since there were no functional changes, I did not introduce any new automated tests.