simonw / simonw/datasette

Internals documentation for datasette.metadata() method

Open
#780 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation metadata plugins
Dominant language
Python
Stars
11.5k
Forks
904
Avg merge
4d 17h
Merged PRs (30d)
18

Description

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 reading the linked implementation in datasette/app.py, lines 297-328, to understand the datasette.metadata() method and identify the behavior that needs documenting. Check the existing documentation structure before choosing where the internals explanation belongs. Done means the method’s internals are documented clearly in the appropriate documentation location.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.