Giter Site home page Giter Site logo

Comments (2)

maelle avatar maelle commented on July 17, 2024

Also, function grouping in reference. If posssible by tags that make grouping exist in the docs as well (am exploring has_concept these days).

from dev_guide.

maelle avatar maelle commented on July 17, 2024

Grouping with has_concept is awesome.

The best thing to do seems to be using @family roxygen2 tags in function documentation, this way

  • there are cross references in the local documentation.
  • current dev roxygen2 transforms all these tags to concept tags as well, that can be used by has_concept in a pkgdown config file to easily obtain grouping in the reference page.

Example in the wild: https://github.com/lockedata/optiRum

from dev_guide.

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.