Comments (3)
I would recommend that for SIGNATURES, missing argument names (eg _) just print their type if it is different from Any. But that may not work for everyone and it could be that we need a new abbrev.
Agreed, that seems like reasonable behaviour.
Incidentally, maybe we could have customizable abbrevs? Eg Signatures(; kwargs...).
Yes, kind of setup already do be able to do something like that if we want to allow customisation. It's just not really been needed til now. So you interpolate a $(MethodSignatures(; type_unnamed_args = true))
in your docstrings instead of the default one. (Name of option TBD).
DocStringExtensions.jl/src/abbreviations.jl
Lines 293 to 311 in ec66ad4
from docstringextensions.jl.
What is the recommended approach to deal with this?
I hadn't put any thought into that particular case, so perhaps there isn't a recommended approach yet. Others feel free to chime in if you've needed this kind of thing.
(Using TYPEDSIGNATURES just gives a docstring without the signature, but maybe that is a separate issue)
If that was resolved to print something out would it go some ways to solving the case for you?
from docstringextensions.jl.
Yes and no. In a lot of cases resolving that would help me. Eg
"""
$(TYPEDSIGNATURES)
"""
foo(x, ::Val{N}) where N= nothing
does precisely what I want, but I could imagine typing x
but not wanting to print that type.
I would recommend that for SIGNATURES
, missing argument names (eg _
) just print their type if it is different from Any
. But that may not work for everyone and it could be that we need a new abbrev.
Incidentally, maybe we could have customizable abbrevs? Eg Signatures(; kwargs...)
.
from docstringextensions.jl.
Related Issues (20)
- Considering writing a script to add function signatures to a code base. HOT 5
- Examples of how to use all of the functionality HOT 5
- expected test failure from the incoming `Core.Compiler` changes HOT 3
- Cannot get source for generated functions
- feature request: non-api doc marker HOT 7
- How to show default values and types of keyword arguments? HOT 1
- Update docs to latest version of Documenter HOT 5
- different abbreviations for concrete and abstract types HOT 1
- FUNCTIONNAME inside a function that generates the docstring HOT 7
- Would it be possible to add a TYPEDMETHODLIST abbreviation HOT 2
- Internal errors when (ab)using `@template` HOT 1
- New SUBTYPES exported key
- FIELDS / TYPEDFIELDS fail on const fields of mutable struct HOT 1
- TYPEDSIGNATURES error with @generated functions HOT 3
- Feature request: option to override template in specific case HOT 4
- Feature request: TYPEDSIGNATURES without output type HOT 1
- Format for all docstrings for a particular function
- Parametric constructors cause `SIGNATURE` and `TYPEDSIGNATURE` to be empty / wrong
- Recompilation and load time HOT 3
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 docstringextensions.jl.