search

neulab / ExplainaBoard

Interpretable Evaluation for AI Systems
MIT License
361 stars 36 forks source link

Teach markdownlint-cli2 to ignore explainaboard/third_party #545

Closed tetsuok closed 2 years ago

tetsuok commented 2 years ago

Currently, the Markdown linter CLI, markdownlint-cli2 is not properly configured to ignore explainaboard/third_party. This is because we used a different type of the configuration file format .markdownlint.yaml, which is a configuration file for the library, markdownlint, not for the CLI. The configuration file doesn't support ignores key. We need to use a configuration file format for the CLI, .markdownlint-cli2.yaml which supports ignoreskey. This PR replaces the .markdownlint.yaml with .markdownlint-cli2.yaml, and fixes the syntax to control rules. (I'll apply similar change in explainaboard_web as well to avoid confusions caused by different config file formats across related repositories)

tetsuok commented 2 years ago

@neubig This issue blocks #532. Would you review this PR? If this looks good, would you merge this PR for me, and then merge main into third_party_code_for_text_to_sql_evaluation?

odashi commented 2 years ago

It looks this change is somewhat urgent; approved it on behalf of assigned reviewers.

tetsuok commented 2 years ago

@odashi Thanks!