Giter VIP home page Giter VIP logo

Comments (5)

alexander-yakushev avatar alexander-yakushev commented on June 13, 2024

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.

bbatsov avatar bbatsov commented on June 13, 2024

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.

alexander-yakushev avatar alexander-yakushev commented on June 13, 2024

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.

alexander-yakushev avatar alexander-yakushev commented on June 13, 2024

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

from compliment.

bbatsov avatar bbatsov commented on June 13, 2024

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

from compliment.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.