Skip to content

Improve reliability of entries and clarity of sections #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimidRobot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve reliability of entries and clarity of sections #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions scripts/shared.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,12 +326,12 @@ def update_readme(
readme_path = path_join(paths["data"], args.quarter, "README.md")

# Define section markers for each data source
section_start_line = f"<!-- section start {section_file} -->\n"
section_end_line = f"<!-- section end {section_file} -->\n"
section_start_line = f"<!-- SECTION start {section_file} -->\n"
section_end_line = f"<!-- SECTION end {section_file} -->\n"

# Define entry markers for each plot (optional) and description
entry_start_line = f"<!-- entry start {entry_title} -->\n"
entry_end_line = f"<!-- entry end {entry_title} -->\n"
entry_start_line = f"<!-- {section_file} entry start {entry_title} -->\n"
entry_end_line = f"<!-- {section_file} entry end {entry_title} -->\n"

if os.path.exists(readme_path):
with open(readme_path, "r", encoding="utf-8") as f:
Expand All @@ -356,7 +356,7 @@ def update_readme(
sections_before = ordered_sections[:current_postion]
# we find the last existing section that comes before this section
for prev_section_title in reversed(sections_before):
prev_end_line = f"<!-- section end {prev_section_title} -->\n"
prev_end_line = f"<!-- SECTION end {prev_section_title} -->\n"
if prev_end_line in lines:
insert_index = lines.index(prev_end_line) + 1
break
Expand Down