Coder Social home page Coder Social logo

Comments (4)

tennlee avatar tennlee commented on July 20, 2024

I think this is because of the compound types in scores.typing.
Another downside of type hinting
Ideally, I would prefer the type hints didn't appear in the function signature area at all, but did appear in the arguments table. I find with the type hinting in the function signatures it's just overwhelming to read. I'm not sure if there's anything configurable in the doc generation toolchain that would let us configure this.

from scores.

nikeethr avatar nikeethr commented on July 20, 2024

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints

setting this to "description" maybe.

from scores.

nikeethr avatar nikeethr commented on July 20, 2024

image

Ok turns out this is due to setting the default threshold arg to np.greater; strange that it didn't cause issues with other "callables" in e.g. event operators. I've changed it to optional and default to None and resolving it to np.greater within the function(s).

Still quite verbose, but at least its consistent with the rest of the docs.

from scores.

tennlee avatar tennlee commented on July 20, 2024

Checkout https://scores.readthedocs.io/en/228-documentation-testing-branch/api.html to see what happens if I change that variable to 'description'. Looks great to me, what do you think?

from scores.

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.