Giter Site home page Giter Site logo

Comments (2)

ziflex avatar ziflex commented on August 22, 2024

Alternatively, we could just have an additional line comments like “since x.x.x”.
It will keep the documentation easy to maintain.
The only downside of this approach is that if we introduce changes in API documentation will contain only recent version.

from montferret.github.io.

ksdme avatar ksdme commented on August 22, 2024

I think we should do both, maintain previous versions while also indicating the minium required version for a function. Doing the versioning thing should be easy as the script would just need to take one additional parameter and change it's output directory to use the one with version suffix, doing the latter would however either require updating comments of each function or using the git tree to find out when the function was first introduced, this however wouldn't indicate stability.

from montferret.github.io.

Related Issues (9)

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.