Documentation generation broken for property pattern?

Offen
#983 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
markdown, python
Bereich
documentation

Rechercherichtung

Untersuche den Pfad zur automatischen Dokumentationsgenerierung und reproduziere das Problem mit einem Property-Muster wie ^[a-zA-Z0-9]+$. Prüfe, wie die Markdown-Ausgabe Zeichen in eckigen Klammern maskiert; abgeschlossen ist die Aufgabe, wenn generierte Muster als Literaltext und nicht als Fußnotensyntax dargestellt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The automatic docs generation is really great to have, thank you!

There does seem to be a small issue with patterns, though. I have a property in my type definition that looks like this:

    "Example": {
      "description": "An example description for this field.",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]+$"
    }

which results in the following Markdown being generated:

_Pattern_: <code>^[a-zA-Z0-9]+$</code>

which is rendered like a footnote:

image ... image

If the [ character is escaped, like this:

_Pattern_: <code>^\[a-zA-Z0-9]+$</code>

then the rendering is more like what I expected to see:

image

It is possible that there are other places that have similar issues; I have not done a deep dive trying to identify other cases.

I'm running version 0.2.28 which appears to be the latest available at the moment.

$ cfn-cli --version
cfn 0.2.28
Vorherrschende Sprache
Python
Sterne
336
Forks
173
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus aws-cloudformation/cloudformation-cli

Alle Issues in aws-cloudformation/cloudformation-cli

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.