tektronix / tektronix/tm_data_types

[FEAT]: Enhance documentation

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

Nobody has claimed this yet.

documentation enhancement good first issue
Dominant language
Python
Stars
8
Forks
14
Avg merge
3d 10h
Merged PRs (30d)
4

Description

Description

This repo needs more extensive documentation.

Additional Information

No response

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

The issue names no documentation files, tests, or entry points. First clarify which parts of tm_data_types need documentation and where that documentation belongs; completion criteria are not defined in the issue.

Written by the indexing model from the issue text.

Assessment

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.