JuliaLang/julia

Better documentation for `methods`

Open

#34,761 opened on Feb 14, 2020

View on GitHubContributor guide
 (11 comments) (0 reactions) (0 assignees)Julia (5,773 forks)batch import
docsgood first issue

Repository metrics

Stars
 (48,709 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Examine the current documentation for the `methods` function in Julia's standard library and identify areas where the behavior regarding method collection and matching is insufficiently explained.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65