Comments (4)
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.
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints
setting this to "description" maybe.
from scores.
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.
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)
- FSS: test `dask`
- Documentation Update (main issue) HOT 7
- Update "latest" to "stable" links in README.md
- How to specify relative links to API docs HOT 4
- How to update links to tutorials
- Dependency freezing for stability when tagging HOT 6
- Remove note about further testing and review
- Cyclic block bootstrapping alternate version HOT 1
- JOSS paper submission
- Data sources description tidyup HOT 2
- Documentation uplift for contingency manager classes
- Should the argument names for ThresholdEventOperator be changed? HOT 1
- Mathjax lines too long
- [JOSS] Lisence is not correctly specified HOT 4
- [JOSS] Consider tracking coverage HOT 3
- [JOSS] Number scheme is not explained HOT 2
- [JOSS] JOSS statement of need should be expanded HOT 4
- [JOSS] Mention binder availability in README HOT 2
- [JOSS] Add a end-to-end example HOT 3
- [JOSS] Fix warnings in test suite and examples HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from scores.