JuliaDiff / JuliaDiff/BlueStyle

Documentation for Internal Functions

Open
#86 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
519
Forks
34
PR merge metrics
No merged PRs in 30d

Description

Documentation is nice to define inputs/outputs and what a function does. Extending this out to internal functions would be nice as well, especially when coming back to revise the function. However, I don't think it's necessary to outline a full docstr for these internal functions.

Any thoughts on this? Suggestions for a format? Maybe something like,

function _foobar(x, y; z)
    """
    Explanation of what foobar does, maybe explain why it does things in a certain way?
    Have docstr inside the function for quick glance value that a function is internal?
    """
end

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

The issue names no file or test; start with the linked BlueStyle documentation and the internal-function example in the issue. Decide whether a reduced documentation format is appropriate, then document the agreed convention in the style guide so the expected format is clear.

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.