Documentation comments corrections #10693
Conversation
Here in this file there were some corrections that I thought would be better if corrected. Now the documentation comments are all good .
|
|
||
| Relies on Python's set class. This tests for object equality | ||
| All inputs are sympified | ||
| All inputs are simplified |
There was a problem hiding this comment.
I know simpify() function is there in sympy and with that reference it was written sympified . But my arguments are as follows:-
- There is no such word like sympified in dictionary .
- For the novice it would be better to understand code if we keep it more simplified.
In case my points are not valid then i can revert that to sympified.
There was a problem hiding this comment.
I'd leave it as is. sympify() and simplify() are two explicitly different functions as pointed out in the tutorial. As such changing it to simplified would be likely to create more confusion as that is not the function that is being used.
|
The top two sets of changes in this PR are correctly fixing grammatical/spelling errors and as such would be useful to add to the repository. |
gxyd
changed the title
|
This PR has been inactive for quite sometime, so we are going to close it and open an issue to reference it. We try to keep our pull request queue small and focused on active work. We encourage you to reopen the pull request if and when you continue to work on this. Please contact us if you have any questions. Thanks for contributing. see https://github.com/sympy/sympy/wiki/Closing-pull-requests for our policies on closing pull request. I've opened #13527 for this pull request so that we don't forget about it. |
Community,
Here in the sets.py file there were some corrections that I thought would be better if corrected. Now the documentation comments are all better understandable .
Cheers !