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

Jump to bottom

Fix #1352 Add checkdoc to build #1957

Merged
merged 4 commits into from Mar 10, 2017
Merged

Fix #1352 Add checkdoc to build #1957

merged 4 commits into from Mar 10, 2017

Conversation

slipset
Copy link
Contributor

@slipset slipset commented Mar 10, 2017 •
edited

  • fix doc strings as to checkdoc
  • add checkdoc to cider-checks

fixes #1352

  • [x ] The commits are consistent with our [contribution guidelines][1]
  • You've added tests (if possible) to cover your change(s)
  • [x ] All tests are passing (make test)
  • [x ] The new code is not generating bytecode or M-x checkdoc warnings
  • You've updated the changelog (if adding/changing user-visible functionality)
  • You've updated the readme (if adding/changing user-visible functionality)
  • You've updated the refcard (if you made changes to the commands listed there)

@slipset
add checkdoc to build
ed44116 
- fix doc strings as to checkdoc
- add checkdoc to cider-checks
- still missing nice way to make checkdoc ignore verb-tenses

fixes clojure-emacs#1352
@slipset
- fix wording to please checkdoc
155d000
@slipset
- don't care about verbs
fbd351e
@bbatsov
Copy link
Member

bbatsov commented Mar 10, 2017

I think you should also add this to travis, right now it's not being ran automatically.

bbatsov
bbatsov reviewed Mar 10, 2017
View reviewed changes
cider-test.el
@@ -61,7 +61,7 @@

(defcustom cider-test-defining-forms '("deftest" "defspec")
"Forms that define individual tests.
CIDER considers the top-level form around point to define a test if the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you shouldn't be doing changes like this. Maybe quoting those words would be better. After all the terminology for this is top-level.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0cdc5a6

@slipset
Copy link
Contributor Author

slipset commented Mar 10, 2017 •
edited

I think it's already added to travis as I removed the comments around

  (dolist (file files)
    (checkdoc-file file))

in test/cider-checks.el which to my understanding is what's run when make test is run?

@bbatsov
Copy link
Member

bbatsov commented Mar 10, 2017 via email

@slipset
Copy link
Contributor Author

slipset commented Mar 10, 2017

I'm of the understanding that checkdocs is silent when it's happy.

@bbatsov
Copy link
Member

bbatsov commented Mar 10, 2017

I'm of the understanding that checkdocs is silent when it's happy.

Perhaps. Just add some messages like checkdoc started, checkdoc checking file X and we're done.

@bbatsov
Copy link
Member

bbatsov commented Mar 10, 2017

Forget what I said. I just noticed it in the build. :-)

@bbatsov bbatsov merged commit 00b44fd into clojure-emacs:master Mar 10, 2017
johnv02139 pushed a commit to johnv02139/cider that referenced this pull request Mar 10, 2018
@slipset @johnv02139
[Fix clojure-emacs#1352] Add checkdoc to build (clojure-emacs#1957)
af94c32 
This also fixes some issues checkdoc was currently reporting.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbatsov bbatsov bbatsov left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Run checkdoc
2 participants
@slipset @bbatsov