JuliaAnimators/Javis.jl

Improve Docstring References

Open

#167 opened on Sep 13, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (50 forks)batch import
documentationenhancementhacktoberfest

Repository metrics

Stars
 (847 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Is your feature request related to a problem? Please explain.

We have a lot of functions named similarly. Therefore, let's fix that up some using Documenter.jl syntax.

Describe the solution you'd like

Based on conversation with @Wikunia , here were some ideas.

f(::Type1, ::Type2)
[`g`](@ref Main.Other.g)

Contributor guide

Research direction
Add docstring references using Documenter.jl syntax. Identify functions with similar names and use the @docs block or @ref syntax to link to specific methods.
Tech stack
julia
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.
Under 1 hour
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.
Clear
Prerequisites
JuliaDocumenter.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80