simonw / simonw/datasette

Redesign register_facet_classes plugin hook

Open
#830 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Nothing uses this plugin hook yet, so the design is not yet proven.

I'm going to build a real plugin against it and use that process to inform any design changes that may need to be made.

I'll add a warning about this to the documentation.

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 reviewing the existing register_facet_classes plugin hook and the documentation warning described in the issue. Build a real plugin to exercise the hook, then use that experience to determine whether the design needs changes and update the documentation accordingly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.