Giter Site home page Giter Site logo

Python `help(f3d)` is not helpful about f3d HOT 2 OPEN

Meakk avatar Meakk commented on May 26, 2024
Python `help(f3d)` is not helpful

from f3d.

Comments (2)

mwestphal avatar mwestphal commented on May 26, 2024

@Meakk @snoyer do you know what we need to do to improve this ?

from f3d.

snoyer avatar snoyer commented on May 26, 2024

I believe it is generated through https://docs.python.org/3/library/pydoc.html so we'd need to study the documentation.

off the top of my head:

  • having a doctring at the top of the file ("""triple quoted text""") should avoid it picking up the # This file is auto-generated by comment as description
  • the internal stuff we don't want to show up can be prefixed with underscore to "make it private", ie. rename F3D_ABSOLUTE_DLLS to _F3D_ABSOLUTE_DLLS and so on
  • not sure how to make it list the functions from the pybind lib tho

from f3d.

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.