Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indentation is hard to read #147

Open
ekampp opened this issue Nov 6, 2024 · 2 comments
Open

Indentation is hard to read #147

ekampp opened this issue Nov 6, 2024 · 2 comments

Comments

@ekampp
Copy link
Contributor

ekampp commented Nov 6, 2024

I'm seeing some confusion on Discord about the whitespace being hard to read.

It seems to assume that it will be read from the top, and the user will add keys and indentation as they go along.

But if you jump into a section that's deeply nested, the example may simply be key: value

I would love to spark a conversation about how to make the whitespace more readable, or provide something like JSON path hints to the sections.

@ekampp
Copy link
Contributor Author

ekampp commented Nov 6, 2024

Some keys, may be used multiple places, and this leads to ambiguity about the possible values.

@alexandrunastase
Copy link

Maybe providing richer examples, that include more of the tree could improve this. Unless you have some context it's kinda hard to figure out sometimes where that particular key should fit in, especially given the upgrade to version 2, which changes a few things around, even more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants