human readable description

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

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

Research direction

The issue points to yardl files and links to microsoft/yardl#195 as related context. Read that issue to understand the desired human readable description, then identify which PETSIRD yardl files need descriptions. Done means those files have readable descriptions that address the linked request.

Written by the indexing model from the issue text.

Description

yardl files are great, but we need a readable description as well. I've created https://github.com/microsoft/yardl/issues/195

Dominant language
Python
Stars
15
Forks
18
Avg merge
1d 11h
Merged PRs (30d)
12

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

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 ETSInitiative/PETSIRD

All issues in ETSInitiative/PETSIRD

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.