Skip to content

Commit 9d8b082

Browse files
committed
Merge remote-tracking branch 'upstream/main' into data
2 parents 16c26c3 + 0787051 commit 9d8b082

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,13 @@ When run this way, the shared library (`scripts/shared.py`) provides easy access
227227
to all of the necessary paths and all of the modules managed by pipenv are
228228
available.
229229
230+
In order for scripts to be run directly (as shown above), the script must be
231+
executable. For more information on making files executable, please see:
232+
[File Permissions - Foundational technologies — Creative Commons Open
233+
Source][file-perms].
234+
235+
[file-perms]: https://opensource.creativecommons.org/contributing-code/foundational-tech/#file-permissions
236+
230237
231238
### Static analysis
232239

scripts/shared.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -335,12 +335,12 @@ def update_readme(
335335
readme_path = path_join(paths["data"], args.quarter, "README.md")
336336

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

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

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

0 commit comments

Comments
 (0)