Skip to content

Confusing output for keys with periods in them #16

@jdbaldry

Description

@jdbaldry

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions