DamienCassou / json-navigator

View and navigate JSON structures
GNU General Public License v3.0
149 stars 7 forks source link

Documentation issue #11

Closed woodensquares closed 6 years ago

woodensquares commented 6 years ago

The README states that one would use json-navigator-navigator but from the code shouldn't this be json-navigator-navigate-after-point?

If you don't mind an additional suggestion, the README could also mention the available navigation keys (tab/s-tab/enter) and/or mention that the resulting tree is simply a tree-widget (meaning one could use tree-mode, for example, to get additional functionality like expanding x levels etc.)

DamienCassou commented 6 years ago

woodensquares notifications@github.com writes:

The README states that one would use json-navigator-navigator but from the code shouldn't this be json-navigator-navigate-after-point?

I agree with you

If you don't mind an additional suggestion, the README could also mention the available navigation keys (tab/s-tab/enter) and/or mention that the resulting tree is simply a tree-widget (meaning one could use tree-mode, for example, to get additional functionality like expanding x levels etc.)

could you please prepare a PR with both changes?

Thanks

-- Damien Cassou http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill

woodensquares commented 6 years ago

done, note I also changed the header in the .el file to satisfy the linter.

DamienCassou commented 6 years ago

Thank you.

woodensquares commented 6 years ago

no problem, thanks for the package!