Determine documentation needs for 2T HVDC

Open
#280 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
julia
Domain
documentation

Research direction

Start by reviewing the 2T HVDC models and the project's existing documentation. Determine whether docstrings, explanations, and how-tos or tutorials are needed, then record each specific documentation need as a separate issue. Done means the documentation gaps are identified and follow-up issues have been created.

Written by the indexing model from the issue text.

Description

documentation

Determine what the documentation needs are for the 2T HVDC models. Of the following items, which ones are necessary for this project:

  • Docstrings
  • Explanations
  • How-tos/tutorials

An output of this should be the creation of new issues for each specific documentation need

Dominant language
Julia
Stars
2
Forks
1
Avg merge
1d 16h
Merged PRs (30d)
26

Contributor guide

Open the contributing guide

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.

More from Sienna-Platform/PowerOperationsModels.jl

All issues in Sienna-Platform/PowerOperationsModels.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.