From a1cac685963fa4bf9b20e587391a1189e8a1a38f Mon Sep 17 00:00:00 2001 From: Cam Saul <cam@geotip.com> Date: Mon, 23 Feb 2015 12:25:15 -0800 Subject: [PATCH] Makefile for making dox --- Makefile | 18 ++++++++++++++++++ src/metabase/api/common.clj | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 00000000000..5d969cc4f77 --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +.PHONY: dox + +# Generate marginalia dox and push them to GitHub pages for this repo +# You should do this from an up-to-date `master` branch without untracked local changes +dox: + git checkout master + git pull + lein marg + cp ./docs/uberdoc.html ./uberdoc.html + git checkout gh-pages + git pull + rm index.html + mv uberdoc.html index.html + git add index.html + git commit -m "Updated dox." + git push --set-upstream origin gh-pages + git checkout master + rm uberdoc.html diff --git a/src/metabase/api/common.clj b/src/metabase/api/common.clj index 6113cec28c3..7f37f7dc246 100644 --- a/src/metabase/api/common.clj +++ b/src/metabase/api/common.clj @@ -184,7 +184,7 @@ ;; ## NEW PERMISSIONS CHECKING MACROS -;; Since checking `@can_read` `@can_write` is such a common pattern, these +;; Since checking `@can_read`/`@can_write` is such a common pattern, these ;; macros eliminate a bit of the redundancy around doing so. ;; They support two forms: ;; -- GitLab