Skip to content

コードブロック後の修飾の抽出を厳密化 #9

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

Merged
merged 2 commits into from
Dec 10, 2024

Conversation

akinomyoga
Copy link
Member

説明は commit message に書いていますのでそちらをご参照下さい。

また、この修正の後は #8 における qualified_fenced_code.pyfix_display_error.py の優先度 28 & 29 (つまり適用順序) を逆転したら fix_display_error.py を単純化できるのではないかと思っています (ちゃんと確かめていないですが…)。

Ref. [1] で発見された問題。コードブロック後に改行を挟まずに文章を続け
るとその文章がコード修飾指定のセクションとして抽出されて消失する問題。
対処法として改行を挿入する [2, 3] ことで回避できるが、改行がなくても正
しく表示されるようにしたい。ここでは、コード修飾の指定についてより厳密
な形式で抽出を行い、誤って関係ない物を抽出することを防ぐ [4]。

この変更のテストの過程で、既存のコード修飾の誤りが発見されたが対処した
[5]。また、他にも消失している記述 [6] が発見されたが、[6] はこの変更に
より自動的に修正されるので対処はしていない。

References:

[1] cpprefjp/site#1362 (comment)
[2] cpprefjp/site@c747f4a
[3] cpprefjp/site@5259ff6
[4] cpprefjp#8 (comment)
[5] cpprefjp/site@ebf8c8f
[6] https://github.com/cpprefjp/site/blob/ebf8c8fd705a194adb7b3f83786dad9c843d143b/reference/generator/generator/iterator/op_increment.md?plain=1#L27
@akinomyoga
Copy link
Member Author

追加修正 941d376#8is_item_line のチェックだと -+1. などによる箇条書き・番号リストでもコード修飾判定になっていたので、当初それらもコード修飾として受け付けるようにしていましたが、qualified_fenced_code の方だと * の項目しか処理していないみたいなので、それに倣って抽出でも * を要求するように変更しました。

@faithandbrave
Copy link
Member

ありがとうございます!マージしてしまっていいでしょうか?

@akinomyoga
Copy link
Member Author

OKです! よろしくおねがいします

@faithandbrave faithandbrave merged commit e1f7fc7 into cpprefjp:master Dec 10, 2024
@akinomyoga akinomyoga deleted the strict-qualifier branch December 10, 2024 14:58
@akinomyoga
Copy link
Member Author

ありがとうございます!

@faithandbrave
Copy link
Member

ありゃ、なんかおかしくなってますね。。。
スクリーンショット 2024-12-11 11 34 28

cpprefjp/cpprefjp.github.io@14ea404

https://cpprefjp.github.io/reference/chrono/duration/formatter.html

@faithandbrave
Copy link
Member

あ、*じゃない箇条書きでコード修飾してあるやつが、おかしな表示になってるのか

@faithandbrave
Copy link
Member

cpprefjp/siteの表示崩れチェッカーに検出を追加しておきます

@akinomyoga
Copy link
Member Author

本当ですね…すみません。[-+*] から \* に制限した後は動作確認していませんでした。実際のコード修飾については変化がないようなので、これらの指定は今までは単に無視されていたみたいですね。

@akinomyoga
Copy link
Member Author

akinomyoga commented Dec 11, 2024

cpprefjp/site@587d612

追記: 手元で見たら動作確認のための再変換だけ実行開始して放置した状態だったので、すぐ変化を確認できました。取り敢えずこれで全てのはずです。

@faithandbrave
Copy link
Member

@akinomyoga 対応ありがとうございます!

これはCIでのエラーチェックはしなくていい気がしてきました。
意図してコード修飾じゃない箇条書きを書くことがありそうなので。

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 this pull request may close these issues.

2 participants