Documentation generation broken for property pattern?
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:
...
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:
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
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus aws-cloudformation/cloudformation-cli
-
docs: `--use-docker` and `--no-docker` options of `cfn submit` are missing from the documentationOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 92/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
aws-cloudformation/cloudformation-cli#1117 · 1 Kommentar · 6 Reaktionen ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
aws-cloudformation/cloudformation-cli#1115 · 1 Kommentar · 9 Reaktionen ·
Alle Issues in aws-cloudformation/cloudformation-cli
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
-
Needs Triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 80/100
pandas-dev/pandas#72163 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
LightFM prepare_test_df ignores mapping values and silently mislabels evaluation pairsEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 79/100
recommenders-team/recommenders#2480 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
521xueweihan/HelloGitHub#4385 ·
-
🐛 bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
pdm-project/pdm#4012 ·
Maintainer antworten meist innerhalb von 1 Tag