Tests

[bbatsov]

I recently started using compliment in CIDER as a replacement for clojure-complete. While it works great I noticed there are neither tests nor integration documentation. Sure, the public API is two functions, but I think you'll make developer lives easier if they had a formal specification in the form of tests.

[alexander-yakushev]

I've been planning for a long time to write documentation on extension (writing custom completion sources). Can you please explain what is integration documentation? What exactly should it contain?

Speaking of tests, I'm not really TDD kind of person, but I'll see what can be done. Maybe it is a chance to finally start writing tests somewhere:).

[bbatsov]

By integration documentation I mean examples of code people would have to write to wire compliment with their existing projects. That should basically be a short section in the readme about completions and documentation.

As for the tests - it's not that important whether you follow TDD or no, but it's always a good idea to have some tests in the end as they act as an executable specification of your library. I would have written the tests myself directly, but I'm not that familiar with the code yet. I guess you can draw a bit of inspiration from here https://github.com/ninjudd/clojure-complete/blob/master/test/complete/core_test.clj.

[alexander-yakushev]

OK, I'll write the tests, that shouldn't be hard. As for the docs, I skipped that part as users don't really call those two functions directly, but I can see how this info might benefit developers. I guess it would go to wiki together with information on context and extension docs.

[alexander-yakushev]

Done with the tests. Do you think it is enough, or explicit documentation on public functions is still necessary?

[bbatsov]

The tests look good. I think that will do for now.