catalyst-cooperative/ferc-xbrl-extractor

Extracted datapackage description is not that useful compared to title

Open

#369 opened on Sep 22, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (3 forks)auto 404
documentationgood first issuemetadata

Repository metrics

Stars
 (15 stars)
PR merge metrics
 (Avg merge 1d) (8 merged PRs in 30d)

Description

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

  • ...

Contributor guide

Research direction
Find where the description is assigned in the taxonomy extraction code and replace it with the title value.
Tech stack
python
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85