Highlight the use of Julia boolean style#92
Conversation
It may be helpful to users to inform them that the wrapper uses lowercase Julia booleans rather than Python booleans, that is not made specifically clear anywhere.
|
Thanks for suggesting this! I think it's not really necessary though since I don't think it would be common for someone to think that literals would use Python syntax instead of Julia syntax. For example, the literal syntax for floating point numbers, strings, booleans, matrices, etc is different between Python and Julia and I don't think the readme of this package is the right place to document all of that. However, I think adding a link to the the PyCall documentation and mentioning that values accepted by the API of this package generally go through the same conversion as arguments passed to PyCall (which would include Julia 'true' being converted to Python's 'True') could indeed be useful. |
|
@malmaud OK I guess you obviously have a better grasp of what is "common" to a new user than I do. However given that this is a wrapper to Pandas and makes the statement that
That in itself almost suggests and hints to the user that Pandas arguments are valid. Most of the time user is probably going to be REPL'ing in the terminal at I digress, but given that a fair percentage of new users will be from a Python background having spent years thinking I guess this falls under the paradigm discussed in https://discourse.julialang.org/t/non-friendly-documentation/38109
@malmaud I have updated this PR with your suggestion referencing PyCall Usage, however in my opinion it is opaque, therefore I have modified the PR to just state it once. Hopefully that is not too much bloat for README.md Apologies if this is a bit of a rant, however having spent many days converting a handful of simple algorithms from Python to Julia and having spent hours iterating with trial and error over every conceivable way I could think of to try and get Pandas.jl actually has some of the |
It may be helpful to users to inform them that the wrapper uses lowercase Julia booleans rather than Python booleans, that is not made specifically clear anywhere.