PokeAPI / PokeAPI/pokeapi

Seeking feedback before overhauling items

Open
#1,101 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5.4k
Forks
1.2k
Avg merge
2d 5h
Merged PRs (30d)
21

Description

I'd really like to add the approximately 350 items we're currently missing (the ones from Legends: Arceus and Scarlet/Violet), but I can't shake the notion that now'd be a good time to take the opportunity to fix all the "misalignment" currently present in items.csv. It's clear that the file has grown organically over the years, with contributors haphazardly discovering missing items and appending them with the next available ID. This system does work, but I think it'd be nice (both aesthetically and in terms of data "purity") if our indexing matched something canonical.

Unsurprisingly, the vast majority of our items are present in SV's list, but there are some discrepancies, namely 40 that are absent and 18 that would need minor renaming (not counting two-digit TMs). There are plenty of gaps in the list, and it's occasionally "obvious" where we could slot in some of our absentees, but that would seem to defeat the purpose. I think it'd be fine to special-case them with 10000+ IDs, the way we do currently for Black Augurite and Peat Block (which I must say is hard to make sense of).

I appreciate that this would involve a great deal of modification to lots of tables, but I'd be happy to script the remapping and presumably make this a non-issue for the foreseeable future (there were only a handful of item index changes between Generations VII and VIII, and none between VIII and IX). It's a fairly invasive change (plus it's not perfectly clear what we should do about the many blank/??? items), so it seemed like a good idea to gauge consensus before proceeding.

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 items.csv and the linked SV item list and discrepancies list; then inspect the affected tables and existing 10000+ IDs before deciding whether the proposed canonical remapping is acceptable. Done means the project has consensus on handling missing, renamed, and blank/??? items and a concrete scope for the remapping; no implementation is specified yet.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Feature
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.