GithubHelp home page GithubHelp logo

Comments (3)

kushagra189 avatar kushagra189 commented on July 29, 2024

@uniqueg should I go ahead with this recommended styling for docstrings?

from foca.

kushagra189 avatar kushagra189 commented on July 29, 2024

@uniqueg can you elaborate what all methods are private? Also, the idea is to hide them and not document within the docs?

from foca.

uniqueg avatar uniqueg commented on July 29, 2024

Never really saw that comment @kushagra189: I think we would want to "hide" everything that the users don't really need. So what do they need to know about:

  • foca.foca.foca() function: to understand the main entry point into FOCA
  • foca.models.config module: to understand how to write the config file
  • foca.utilities subpackage: to see what useful functions they can import and reuse

I think everything else can be skipped from the API docs. As for how to skip them: I would probably not completely hide them, but change the table of contents in API docs so that only these are visible from the start. It would probably still be good to leave everything else in, perhaps under a link "complete API documentation" or so, as it is still useful for FOCA developers (and sometimes app developers, too, if there are some bugs/issues).

from foca.

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.