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

Confusing output for keys with periods in them #16

Open
jdbaldry opened this issue Mar 2, 2021 · 1 comment · May be fixed by #34
Open

Confusing output for keys with periods in them #16

jdbaldry opened this issue Mar 2, 2021 · 1 comment · May be fixed by #34

Comments

@jdbaldry
Copy link

jdbaldry commented Mar 2, 2021

Both docsonnet documentation fields below are rendered similarly such that I imagine a user could easily be confused by the structure of the data when seeing the Markdown documentation for a key with periods . in it.

{
  '#has.a.period': d.val('help'),
  'has.a.period': null,
  has: {
    a: {
      '#period': d.val('help'),
      period: null,
    },
  },
}

I guess keys that require quoting in Jsonnet should be enclosed in square brackets, the same as in Jsonnet so that the first key becomes ['has.a.period'] in the rendered documentation and the second key stays as has.a.period.

@Duologic Duologic linked a pull request Oct 23, 2022 that will close this issue
@Duologic
Copy link
Member

I've made an attempt to fix this in the jsonnet renderer, it is more complex than I anticipated so I haven't looked at the golang version yet.

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

Successfully merging a pull request may close this issue.

2 participants