mysociety / mysociety/data_common

YAML in Jekyll site converting 'No' to a boolean No

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

(Paraphrased from Alex)
Where jekyll_management.py has the following line:

        yaml.dump(data, f)

The jeykll file is read back in, and then dumped again into the markdown file, so what needs to happen is that yaml is dumped to a string, gets the same fix, and then dumped in the markdown file

Contributor guide

No contributing guide indexed for this repository

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 in src/data_common/dataset/jekyll_management.py at the yaml.dump(data, f) call and trace how the Jekyll file is read and then written into Markdown. Verify how the YAML string should be handled so a literal “No” remains a string after the round trip. Done means the generated Markdown no longer converts “No” into a boolean.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.