JuliaCollections / JuliaCollections/DataStructures.jl

Improve docstrings and doc

Open
#360 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
745
Forks
261
PR merge metrics
No merged PRs in 30d

Description

Hello,

Doc need now to be improved

Example:
http://juliacollections.github.io/DataStructures.jl/latest/deque.html
(but it also apply to most doc page)

Instead of a usage paragraph with raw Julia code we should use docstrings and @docs

Example of docstring for isempty
https://github.com/JuliaLang/julia/blob/edeb002a13afdce31dac55706433ebb6d5cedd79/base/essentials.jl#L727

Writing doc this way will help to have a doc which really reflect current code (and avoid issues with documentation of constructors such as exposed in #340 )

Maybe a new release should be tagged before tackling this issue because it will be easier to compare latest version (with @docs) to previous (current) version with raw Julia code in doc.

Kind regards

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the deque documentation page linked in the issue and compare its raw Julia usage paragraphs with Julia docstrings and @docs, using the linked isempty example as a reference. Identify the affected documentation pages and convert their examples to reflect the current code; done means the relevant pages consistently use docstrings and @docs rather than duplicated raw usage text.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.