catalyst-cooperative/ferc-xbrl-extractor

Extracted datapackage description is not that useful compared to title

Aperta

#369 aperta il 22 set 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Python (3 fork)auto 404
documentationgood first issuemetadata

Metriche repository

Star
 (15 stelle)
Metriche merge PR
 (Merge medio 1g) (8 PR mergiate in 30 g)

Descrizione

Overview

When we're extracting metadata from the taxonomy, we see these descriptions and titles:

      "title": "001 - Schedule - Corporate Officer Certification - duration",
      "description": "ferc:ScheduleIdentificationAbstract",

The title is kind of useful, and the description is not at all useful.

We should probably put the string that's in "title" in the "description" too.

Currently we're working around this in eel-hole by using the title field to populate the displayed description.

Success Criteria

How will we know that we're done?

  • description field is descriptive

Next steps

  • ...

Guida contributor

Direzione di ricerca
Trova dove viene assegnata la descrizione nel codice di estrazione della tassonomia e sostituiscila con il valore del titolo.
Tech stack
python
Dominio
data
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85