Need documentation

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start by inventorying the files in the pii, ontology, and misc directories and reading their existing interfaces. Identify the documentation format and where usage examples belong before asking for scope clarification. Done means every file in those directories is documented and the requested usage examples are included.

Written by the indexing model from the issue text.

Description

Need documentation for all files in pii, ontology and misc. Need usage examples.

Dominant language
Python
Stars
9
Forks
6
PR merge metrics
No merged PRs in 30d

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.

More from bigscience-workshop/pii_processing

All issues in bigscience-workshop/pii_processing

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.