Git Product home page Git Product logo

Comments (1)

sethaxen avatar sethaxen commented on June 25, 2024

I figured out how to have two types of docs in 2 contexts. For every function forwarded without modification to arviz, we define two types of documentation. The documentation that appears in the docs will just consist of the link to the same function in ArviZ's docs. To make the help messages in the REPL useful, we'll make them show the ArviZ docs.

We'll only define non-linking docs for functions that have been modified in some way. Thus the ArviZ.jl docs will also serve as a diff between the two packages. Then there's no need to adapt ArviZ's docstrings except for those cases where we changed something.

from arviz.jl.

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.