Documentation generation broken for property pattern?

オープン
#983 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
markdown, python
領域
documentation

調査の方向性

自動ドキュメント生成の経路を調査し、^[a-zA-Z0-9]+$ のようなプロパティパターンで問題を再現してください。Markdown 出力で角括弧の文字がどのようにエスケープされるかを確認してください。完了条件は、生成されたパターンが脚注構文ではなくリテラルテキストとして表示されることです。

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
Python
スター
336
フォーク
173
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

aws-cloudformation/cloudformation-cli のほかの issue

aws-cloudformation/cloudformation-cli の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。