Skip to content

Inconsistence in documentation of dataset metadata #843

@ernie55ernie

Description

@ernie55ernie

In the wiki page of dataset metadata, the example containing file metadata has column description with "description" as the key for column descriptor.
But the content below use "title".

Reference link:
Dataset Metadata

Also, file description is set in "description" but not successfully presented in the dataset UI.

{
  "title": "Historical Price for Taiwan Listed and OTC Stocks",
  "subtitle": "Stock Data from Taiwan Stock Exchange and OTC",
  "description": "# Historical Price Information for Taiwan’s Listed and Over-The-Counter Stocks\n\n#### from each security’s listing date until present\n\n---\n\n### ▶ Context 📝\nThis dataset collects daily OHLCV (Open, High, Low, Close, Volume) time-series for every stock listed on the Taiwan Stock Exchange (TWSE) and the over-the-counter (OTC) market, as scraped via our custom Python scripts using the yfinance library.\n\n### ▶ Acknowledgements 🙏\n- Data sourced from [Yahoo Finance](https://finance.yahoo.com) via the yfinance Python package.\n- Stock metadata harvested from the TWSE ISIN service.\n\n### ▶ Inspiration 💭\n- Backtesting quantitative trading strategies on Taiwanese equities\n- Time-series forecasting and anomaly detection across local market sectors\n- Comparative performance analysis between TWSE and OTC listed companies\n\n### ▶ Log 📰\n- **22 June 2025**: Initial release—daily OHLCV data for all TWSE and OTC symbols\n- **[TBD]**: Plan to automate nightly updates after market close\n\n---\n\n📊 *Charts and further analysis can be built directly on top of these CSV files.*",
  "id": "ernie55ernie/historical-price-for-taiwan-listed-and-otc-stocks",
  "licenses": [
    {
      "name": "Other (specified in description)"
    }
  ],
  "resources": [
    {
      "path": "data/1101.csv",
      "description": "Daily historical OHLCV data for `1101.csv`, downloaded via yfinance.",
      "schema": {
        "fields": [
          {
            "name": "Date",
            "description": "Trading date in YYYY-MM-DD format.",
            "type": "date"
          },
          {
            "name": "Open",
            "description": "Opening price.",
            "type": "number"
          },
          {
            "name": "High",
            "description": "Highest price.",
            "type": "number"
          },
          {
            "name": "Low",
            "description": "Lowest price.",
            "type": "number"
          },
          {
            "name": "Close",
            "description": "Closing price.",
            "type": "number"
          },
          {
            "name": "Volume",
            "description": "Daily traded volume.",
            "type": "integer"
          }
        ]
      }
    }
  ],
  "keywords": [
    "Finance",
    "Investing",
    "Time Series Analysis",
    "Tabular",
    "Economics"
  ]
}

Similar issue to dataset-metadata.json fails to upload file and column descriptions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions