SciSharp / SciSharp/NumSharp

Lacking/Outdated Documentation

Open
#479 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
1.5k
Forks
205
Avg merge
7d 7h
Merged PRs (30d)
2

Description

Many methods don't seem to be documented at all, or did I just fail to find the right place to look for?
Also, is this project still maintained or is it discontinued? Seems like not much happened since the release of Numpy.NET, which is a pity.

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.

Research direction

Start by surveying the repository for public methods that lack documentation and checking the existing documentation entry points. The issue names no files, methods, or acceptance criteria, so confirm the project's maintenance status and agree on a bounded documentation scope before deciding what done means.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.