Comments (5)
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:).
from compliment.
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.
from compliment.
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.
from compliment.
Done with the tests. Do you think it is enough, or explicit documentation on public functions is still necessary?
from compliment.
The tests look good. I think that will do for now.
from compliment.
Related Issues (20)
- No completions for locals if context contains qualified keyword with dot in the name HOT 2
- Suggest private vars when using var-quote? HOT 2
- utils/classes-on-classpath can return non-classes HOT 5
- String literals aren't inferred as strings HOT 6
- Give `some->`/`some->>` similar treatment than that of `->`/`->>` HOT 2
- Type inference from static method calls HOT 1
- License on compliment lite HOT 1
- Good completion suggestions require extra type hints HOT 2
- compliment.sources.class-members could add the class to its candidates HOT 4
- Apply sources feature in the doc functionality as well
- Autocomplete java methods from object returned from a deref? HOT 2
- Recognise alternative let-like formats HOT 4
- is there an example how to use `compliment` within emacs but without cider? HOT 2
- Too many completions for Java objects HOT 3
- Don't offer completions for `^:deprecated` vars? HOT 7
- Some of the latest changes are missing in the released version HOT 7
- ns completions for cljc-files HOT 2
- Doc of ns via alias HOT 3
- proposal: completion and documentation with leading literals HOT 7
- var-quote completions without a ns part HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from compliment.