JuliaLang/julia

Better documentation for `methods`

Open

#34,761 opened on Feb 14, 2020

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
docsgood first issue

Description

I believe methods should have a bit more of information, consider,

struct A end
methods(A)
struct B{T} end
methods(B)
methods(B{Int})
struct C{T}
    C(x) = new{Int}(0)
end
methods(C)

Basically the way that methods are collected / match isn’t well documented.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Juliaunderstanding of multiple dispatch
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the current documentation for methods in base/docs. The issue shows examples of methods(A), methods(B), etc. The goal is to clarify how methods are collected and matched for different types, possibly with inline examples. Look at existing documentation patterns in the Julia manual.