Skip to content
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

Remove Fenced block and WAI-ARIA role from v1.0 #67

Closed
MurakamiShinyu opened this issue Feb 7, 2021 · 2 comments
Closed

Remove Fenced block and WAI-ARIA role from v1.0 #67

MurakamiShinyu opened this issue Feb 7, 2021 · 2 comments
Assignees
Labels
docs spec Spec related thing
Milestone

Comments

@MurakamiShinyu
Copy link
Member

Issues to be implemented as v1.0 (#49) のコメント に書いた仕様見直し案の次のものは、変更が大きく、 v1.0 での対応は困難だと思います。そこでこれらの機能と構文については、vfm v1.0 から削除して、将来の検討課題とするのがよさそうです:

これらの機能は、VFMの特徴的な便利な機能になるかもしれませんが、Markdownの中でHTMLコードを直接書けば実現できます(Markdown記法のすべてに言えることですが)。
👉 spec: Markdown inside HTML blocks (#4)

ユーザーが現状の vfm 実装のこれらの構文を利用して、将来にその仕様が変わることで生じる混乱を防ぐため、ドキュメント類から Fenced block と WAI-ARIA role についての記述を削除する必要があると思います。
ドキュメント類の次のところにそのような記述があります(ほかにもあるかもしれません):

ドキュメントだけでなくプログラムからも現状の機能を削除するかは要検討。残す場合は Experimental で仕様未確定と断り書きが必要だと思います。

@akabekobeko
Copy link
Member

プログラムについて当初、TODO と共に呼び出し部分だけコメントアウトしようと考えていましたが、

  • 後に再実装を試みる際の参考なら Git の履歴から取得できる
  • ドキュメントはコメントアウトできず、v1.0 見送りと注釈するか削除することになる
    • 注釈によってかえって混乱するかもしれない
    • ならばいっそ削除して「利用可能な機能」だけを記載するほうがユーザーにとってわかりやすい

という理由から削除します。

This was referenced Feb 7, 2021
@akabekobeko
Copy link
Member

#5#28 について Milestone v2.0.0 を設定しました。コードとドキュメントのドロップはこれから実施します。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs spec Spec related thing
Projects
None yet
Development

No branches or pull requests

2 participants