Skip to content

Slightly reformat the input data documentation#622

Merged
tsmbland merged 5 commits intomainfrom
input_docs
Jun 13, 2025
Merged

Slightly reformat the input data documentation#622
tsmbland merged 5 commits intomainfrom
input_docs

Conversation

@tsmbland
Copy link
Copy Markdown
Collaborator

@tsmbland tsmbland commented Jun 13, 2025

Description

A suggested change to the input data documentation to make it slightly easier to follow. This is sort of in between what we currently have and what we briefly had before:

Main changes:

  • get rid of the title field
  • use a bullet point list for the main notes
  • put field notes back in the same table with field descriptions

Also added some suggested vscode extensions

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.36%. Comparing base (7827181) to head (94db7ef).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #622      +/-   ##
==========================================
- Coverage   85.39%   85.36%   -0.03%     
==========================================
  Files          38       38              
  Lines        3410     3410              
  Branches     3410     3410              
==========================================
- Hits         2912     2911       -1     
- Misses        305      306       +1     
  Partials      193      193              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tsmbland tsmbland marked this pull request as ready for review June 13, 2025 13:24
@tsmbland tsmbland changed the title Slightly reformat the input documentation Slightly reformat the input data documentation Jun 13, 2025
@tsmbland tsmbland requested a review from alexdewar June 13, 2025 13:25
Copy link
Copy Markdown
Member

@alexdewar alexdewar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Much easier to read.

Just FYI: I used the title and description fields because they're listed in the table schema specification: https://specs.frictionlessdata.io/table-schema/#title

They're both optional fields though, and the frictionless tool at least doesn't seem to object to the extra notes field in there. I was essentially using the title as a description anyway.

A couple of extra things I noticed that are actually my fault:

  1. The demand.yaml schema has a years field that should be year. (You can validate with frictionless validate --schema schemas/input/demand.yaml examples/simple/demand.csv)
  2. The subheadings seem to be repeated over and over, e.g. there's a Commodities subheading above each of the sections for the commodity-related CSV files

You can fix them on this branch or I can do it later.

@@ -26,10 +26,9 @@ This file contains information about the input file format for MUSE 2.0.
(such as a requirement that the value is >=0 etc.). -#}
{%- if file.notes %}
#### Notes
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave a newline after the heading:

Suggested change
#### Notes
#### Notes

@tsmbland
Copy link
Copy Markdown
Collaborator Author

Thanks. All fixed now

@tsmbland tsmbland enabled auto-merge June 13, 2025 14:35
@tsmbland tsmbland merged commit 0b52f84 into main Jun 13, 2025
7 checks passed
@tsmbland tsmbland deleted the input_docs branch June 13, 2025 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants