From d63269ee6a2c5bc506dd594eedc96a132845bf09 Mon Sep 17 00:00:00 2001 From: Eeshan Garg Date: Tue, 15 Aug 2017 19:59:28 -0230 Subject: [PATCH] zulip_bots: Rename bots/{bot}/readme.md -> bots/{bot}/doc.md. doc.md better describes the style of documentation that will live inside these files, since we want these to be similar to our webhooks' doc.md files in terms of how these are rendered and composed of Markdown macros. --- tools/custom_check.py | 2 +- zulip_bots/zulip_bots/bots/commute/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/converter/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/define/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/encrypt/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/foursquare/{readme.md => doc.md} | 0 .../zulip_bots/bots/git_hub_comment/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/github_detail/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/googlesearch/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/helloworld/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/howdoi/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/incrementor/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/john/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/tictactoe/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/virtual_fs/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/weather/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/xkcd/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/yoda/{readme.md => doc.md} | 0 zulip_bots/zulip_bots/bots/youtube/{readme.md => doc.md} | 0 19 files changed, 1 insertion(+), 1 deletion(-) rename zulip_bots/zulip_bots/bots/commute/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/converter/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/define/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/encrypt/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/foursquare/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/git_hub_comment/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/github_detail/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/googlesearch/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/helloworld/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/howdoi/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/incrementor/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/john/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/tictactoe/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/virtual_fs/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/weather/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/xkcd/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/yoda/{readme.md => doc.md} (100%) rename zulip_bots/zulip_bots/bots/youtube/{readme.md => doc.md} (100%) diff --git a/tools/custom_check.py b/tools/custom_check.py index deb994f..6f5d467 100644 --- a/tools/custom_check.py +++ b/tools/custom_check.py @@ -222,7 +222,7 @@ def build_custom_checkers(by_lang): failed = True markdown_docs_length_exclude = { - "zulip_bots/zulip_bots/bots/converter/readme.md", + "zulip_bots/zulip_bots/bots/converter/doc.md", "tools/server_lib/README.md", } for fn in by_lang['md']: diff --git a/zulip_bots/zulip_bots/bots/commute/readme.md b/zulip_bots/zulip_bots/bots/commute/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/commute/readme.md rename to zulip_bots/zulip_bots/bots/commute/doc.md diff --git a/zulip_bots/zulip_bots/bots/converter/readme.md b/zulip_bots/zulip_bots/bots/converter/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/converter/readme.md rename to zulip_bots/zulip_bots/bots/converter/doc.md diff --git a/zulip_bots/zulip_bots/bots/define/readme.md b/zulip_bots/zulip_bots/bots/define/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/define/readme.md rename to zulip_bots/zulip_bots/bots/define/doc.md diff --git a/zulip_bots/zulip_bots/bots/encrypt/readme.md b/zulip_bots/zulip_bots/bots/encrypt/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/encrypt/readme.md rename to zulip_bots/zulip_bots/bots/encrypt/doc.md diff --git a/zulip_bots/zulip_bots/bots/foursquare/readme.md b/zulip_bots/zulip_bots/bots/foursquare/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/foursquare/readme.md rename to zulip_bots/zulip_bots/bots/foursquare/doc.md diff --git a/zulip_bots/zulip_bots/bots/git_hub_comment/readme.md b/zulip_bots/zulip_bots/bots/git_hub_comment/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/git_hub_comment/readme.md rename to zulip_bots/zulip_bots/bots/git_hub_comment/doc.md diff --git a/zulip_bots/zulip_bots/bots/github_detail/readme.md b/zulip_bots/zulip_bots/bots/github_detail/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/github_detail/readme.md rename to zulip_bots/zulip_bots/bots/github_detail/doc.md diff --git a/zulip_bots/zulip_bots/bots/googlesearch/readme.md b/zulip_bots/zulip_bots/bots/googlesearch/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/googlesearch/readme.md rename to zulip_bots/zulip_bots/bots/googlesearch/doc.md diff --git a/zulip_bots/zulip_bots/bots/helloworld/readme.md b/zulip_bots/zulip_bots/bots/helloworld/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/helloworld/readme.md rename to zulip_bots/zulip_bots/bots/helloworld/doc.md diff --git a/zulip_bots/zulip_bots/bots/howdoi/readme.md b/zulip_bots/zulip_bots/bots/howdoi/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/howdoi/readme.md rename to zulip_bots/zulip_bots/bots/howdoi/doc.md diff --git a/zulip_bots/zulip_bots/bots/incrementor/readme.md b/zulip_bots/zulip_bots/bots/incrementor/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/incrementor/readme.md rename to zulip_bots/zulip_bots/bots/incrementor/doc.md diff --git a/zulip_bots/zulip_bots/bots/john/readme.md b/zulip_bots/zulip_bots/bots/john/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/john/readme.md rename to zulip_bots/zulip_bots/bots/john/doc.md diff --git a/zulip_bots/zulip_bots/bots/tictactoe/readme.md b/zulip_bots/zulip_bots/bots/tictactoe/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/tictactoe/readme.md rename to zulip_bots/zulip_bots/bots/tictactoe/doc.md diff --git a/zulip_bots/zulip_bots/bots/virtual_fs/readme.md b/zulip_bots/zulip_bots/bots/virtual_fs/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/virtual_fs/readme.md rename to zulip_bots/zulip_bots/bots/virtual_fs/doc.md diff --git a/zulip_bots/zulip_bots/bots/weather/readme.md b/zulip_bots/zulip_bots/bots/weather/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/weather/readme.md rename to zulip_bots/zulip_bots/bots/weather/doc.md diff --git a/zulip_bots/zulip_bots/bots/xkcd/readme.md b/zulip_bots/zulip_bots/bots/xkcd/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/xkcd/readme.md rename to zulip_bots/zulip_bots/bots/xkcd/doc.md diff --git a/zulip_bots/zulip_bots/bots/yoda/readme.md b/zulip_bots/zulip_bots/bots/yoda/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/yoda/readme.md rename to zulip_bots/zulip_bots/bots/yoda/doc.md diff --git a/zulip_bots/zulip_bots/bots/youtube/readme.md b/zulip_bots/zulip_bots/bots/youtube/doc.md similarity index 100% rename from zulip_bots/zulip_bots/bots/youtube/readme.md rename to zulip_bots/zulip_bots/bots/youtube/doc.md