Skip to content

Split data dictionary into separate markdown tables by SQL table#386

Merged
jd-foster merged 2 commits intodatacarpentry:mainfrom
dmolesUC:split-data-dictionary
Mar 31, 2026
Merged

Split data dictionary into separate markdown tables by SQL table#386
jd-foster merged 2 commits intodatacarpentry:mainfrom
dmolesUC:split-data-dictionary

Conversation

@dmolesUC
Copy link
Copy Markdown
Contributor

@dmolesUC dmolesUC commented Apr 3, 2025

If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.

Closes #384.

Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.

  • Separates the data dictionary into three separate Markdown tables (one per SQL table), so as not to confuse students when they first import only the surveys table
  • Rearranges fields into the order they appear in the DB Browser for SQL Lite interface (= the order of columns in the CSV, which also becomes the SQL declaration order), so it's easier for students to read down the table as they set data types

If any relevant discussions have taken place elsewhere, please provide links to these.

See #384.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 3, 2025

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/datacarpentry/sql-ecology-lesson/compare/md-outputs..md-outputs-PR-386

The following changes were observed in the rendered markdown documents:

 00-sql-introduction.md | 46 ++++++++++++++++++++++++++++++----------------
 md5sum.txt             |  2 +-
 2 files changed, 31 insertions(+), 17 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2026-03-31 11:28:35 +0000

github-actions Bot pushed a commit that referenced this pull request Mar 31, 2026
@jd-foster jd-foster changed the title Split data dictionary into separate markdown tables by SQL table (fix… Split data dictionary into separate markdown tables by SQL table Mar 31, 2026
@jd-foster jd-foster merged commit 01aa1ef into datacarpentry:main Mar 31, 2026
5 checks passed
github-actions Bot pushed a commit that referenced this pull request Mar 31, 2026
Auto-generated via `{sandpaper}`
Source  : 01aa1ef
Branch  : main
Author  : David Moles <dmoles@ucsb.edu>
Time    : 2026-03-31 11:30:33 +0000
Message : Split data dictionary into separate markdown tables by SQL table (#386)

- Separates the data dictionary into three separate Markdown tables (one per SQL table), so as not to confuse students when they first import only the surveys table
- Rearranges fields into the order they appear in the DB Browser for SQL Lite interface (= the order of columns in the CSV, which also becomes the SQL declaration order), so it's easier for students to read down the table as they set data types
github-actions Bot pushed a commit that referenced this pull request Mar 31, 2026
Auto-generated via `{sandpaper}`
Source  : f6db8d1
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-03-31 11:32:32 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 01aa1ef
Branch  : main
Author  : David Moles <dmoles@ucsb.edu>
Time    : 2026-03-31 11:30:33 +0000
Message : Split data dictionary into separate markdown tables by SQL table (#386)

- Separates the data dictionary into three separate Markdown tables (one per SQL table), so as not to confuse students when they first import only the surveys table
- Rearranges fields into the order they appear in the DB Browser for SQL Lite interface (= the order of columns in the CSV, which also becomes the SQL declaration order), so it's easier for students to read down the table as they set data types
github-actions Bot pushed a commit that referenced this pull request Mar 31, 2026
Auto-generated via `{sandpaper}`
Source  : f6db8d1
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-03-31 11:32:32 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 01aa1ef
Branch  : main
Author  : David Moles <dmoles@ucsb.edu>
Time    : 2026-03-31 11:30:33 +0000
Message : Split data dictionary into separate markdown tables by SQL table (#386)

- Separates the data dictionary into three separate Markdown tables (one per SQL table), so as not to confuse students when they first import only the surveys table
- Rearranges fields into the order they appear in the DB Browser for SQL Lite interface (= the order of columns in the CSV, which also becomes the SQL declaration order), so it's easier for students to read down the table as they set data types
github-actions Bot pushed a commit to jd-foster/sql-ecology-lesson that referenced this pull request Mar 31, 2026
Auto-generated via `{sandpaper}`
Source  : 01aa1ef
Branch  : main
Author  : David Moles <dmoles@ucsb.edu>
Time    : 2026-03-31 11:30:33 +0000
Message : Split data dictionary into separate markdown tables by SQL table (datacarpentry#386)

- Separates the data dictionary into three separate Markdown tables (one per SQL table), so as not to confuse students when they first import only the surveys table
- Rearranges fields into the order they appear in the DB Browser for SQL Lite interface (= the order of columns in the CSV, which also becomes the SQL declaration order), so it's easier for students to read down the table as they set data types
github-actions Bot pushed a commit to jd-foster/sql-ecology-lesson that referenced this pull request Mar 31, 2026
Auto-generated via `{sandpaper}`
Source  : e998e62
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-03-31 11:48:49 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 01aa1ef
Branch  : main
Author  : David Moles <dmoles@ucsb.edu>
Time    : 2026-03-31 11:30:33 +0000
Message : Split data dictionary into separate markdown tables by SQL table (datacarpentry#386)

- Separates the data dictionary into three separate Markdown tables (one per SQL table), so as not to confuse students when they first import only the surveys table
- Rearranges fields into the order they appear in the DB Browser for SQL Lite interface (= the order of columns in the CSV, which also becomes the SQL declaration order), so it's easier for students to read down the table as they set data types
jd-foster added a commit that referenced this pull request Apr 1, 2026
Follow-up for #386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit that referenced this pull request Apr 1, 2026
Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (#394)

Follow-up for #386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit that referenced this pull request Apr 1, 2026
Auto-generated via `{sandpaper}`
Source  : ab0f233
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-04-01 05:28:09 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (#394)

Follow-up for #386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit to jd-foster/sql-ecology-lesson that referenced this pull request Apr 1, 2026
Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (datacarpentry#394)

Follow-up for datacarpentry#386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit to jd-foster/sql-ecology-lesson that referenced this pull request Apr 1, 2026
Auto-generated via `{sandpaper}`
Source  : 92e3a85
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-04-01 05:37:56 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (datacarpentry#394)

Follow-up for datacarpentry#386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit that referenced this pull request Apr 7, 2026
Auto-generated via `{sandpaper}`
Source  : ab0f233
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-04-01 05:28:09 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (#394)

Follow-up for #386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit that referenced this pull request Apr 14, 2026
Auto-generated via `{sandpaper}`
Source  : ab0f233
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-04-01 05:28:09 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (#394)

Follow-up for #386 to fix formatting of tables and challenge.
github-actions Bot pushed a commit that referenced this pull request Apr 21, 2026
Auto-generated via `{sandpaper}`
Source  : ab0f233
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-04-01 05:28:09 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5f9ef9e
Branch  : main
Author  : James Foster <38274066+jd-foster@users.noreply.github.com>
Time    : 2026-04-01 05:25:13 +0000
Message : Formatting fixes follow-up (#394)

Follow-up for #386 to fix formatting of tables and challenge.
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.

Inclusion of multiple tables in Introduction's data dictionary is potentially confusing

2 participants