Small typo and grammar fix

michaelaye commented 1 year ago

You might also have a look at line 86: unless I'm missing it, gui__ isn't described as what it is? A string with a parameter setting? A dict?

Description

Related Issue

Motivation and Context

How Has This Been Tested?

make lint
make docs
make test-all

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Licensing:

This project is released under the LICENSE.

I claim copyrights on my contributions in this pull request, and I provide those contributions via this pull request under the same license terms that the pvl project uses.
I dedicate any and all copyright interest in my contributions in this pull request to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this contribution under copyright law.

rbeyer commented 1 year ago

Hmm, yes line 86 isn't right. I don't have time to test deeply right now, but I think this will correct it and allow the line to run as described:

isis.hist('some.cub', 'gui__', min_=5)

However, that's not great logic, as it brings the parameter naming (with trailing underbars) into the values of the argument list. Maybe the pattern should be:

isis.hist('some.cub', '-gui', min_=5)

So it echoes the command line syntax for these options? I'm going to have to think about this some more. Thank you.

rbeyer commented 1 year ago

I thought about it more, and have included the additional way to specify parameters in PR #14. If you could make the change to the line you're already altering above, I'd be happy to approve this PR, thank you.

rbeyer commented 1 year ago

That typo is my own, and I'll take care of it in PR #14.

rbeyer / kalasiris