redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

Published 20 hours ago • verified publisher icon Redocly

document or delete info-description rule

Open adamaltman opened this issue 3 years ago • 2 comments

We should document or delete the info-description rule. It feels a bit unnecessary given assertions capability to do that equivalent really easily.

adamaltman avatar Sep 06 '22 19:09 adamaltman

I'd vote for deletion.

tatomyr avatar Sep 21 '22 09:09 tatomyr

Let's do it then.

adamaltman avatar Sep 21 '22 19:09 adamaltman

any reason the vote was against an info-description rule? the PR states it's easy to make an assertion

Are you planning to remove any rule that can be an assertion in the future? Are you documenting and sharing any list of assertions currently available?

jeremyfiel avatar Oct 20 '22 15:10 jeremyfiel

Are you planning to remove any rule that can be an assertion in the future?

@jeremyfiel No we don't :)

Are you documenting and sharing any list of assertions currently available?

We are still working on changes to the assertions syntax. We do plan to remove the undefined assertion (since it duplicates the defined one). You can check the current state in the draft here: https://github.com/Redocly/redocly-cli/pull/917

tatomyr avatar Oct 24 '22 09:10 tatomyr