Git Product home page Git Product logo

Comments (6)

shwina avatar shwina commented on May 29, 2024

@DamienIrving @IsaKiko
Can you think of anything that we are missing here?

from matlab-novice-inflammation.

abought avatar abought commented on May 29, 2024

I've run the most current version of the validator on the latest gh-pages branch of this repo. This can be done using the command tools/check . from the root lesson folder (or check an individual file, eg tools/check 01-intro.md).

Below is a complete log; I've tried to annotate some of the less obvious error messages to help guide template conversion. This is the first real trial-by-fire exercise on the validator, so feedback on how to make it more helpful is welcome.

Summary points

I like what I see of this lesson!

For conversion: The checklist of files to fix should be amended to include sample lesson pages. You may want to break some of the lesson pages into smaller chunks. Certain pages have required sections that need to be added, and the YAML headers should be updated to match the template.

Also, no need for so much custom HTML in lesson pages in the current spec.

Annotated examples from the validator output

ERROR:root:In ./01-intro.md: The topic page should not have sub-headings outside of special blocks. If a topic needs sub-headings, it should be broken into multiple topics.

The most current lesson template description is probably this: https://github.com/swcarpentry/lesson-template/blob/gh-pages/LAYOUT.md . It calls for pages to have fewer subheadings, and suggests breaking those out into separate lesson topics.

WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Challenges

Challenges are now blockquoted sections with a custom style. See LAYOUT.md.

ERROR:root:In ./01-intro.md: Learning Objectives should not be empty.

A bit misleading... strictly speaking, the first block after the YAML header for every lesson page should be the learning objectives section. There is no Learning Objectives block in this lesson.

WARNING:root:In ./01-intro.md: Unrecognized label in header section: root

The YAML headers (lines at the top of the file) need to be updated to match the template. It no longer asks you to specify the root directory. You will need a few other new headings (subtitle and minutes) as well. (will update validator to be more helpful on the latter) See LAYOUT.md for examples.

ERROR:root:In ./01-intro.md: Heading at line 45 should be level 2

All headers in all documents must be exactly level 2, aka prefixed by "##". (This requirement may change depending on feedback from lesson creators!)

ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#current-working-directory in ./../../gloss.html#current-working-directory. If this is a URL, it must be prefixed with http(s):// or ftp://.

This error message needs to be improved. If you link to an HTML file in the lesson directory, then there should be a markdown file with the same name. It is looking for "gloss.md", in the same folder as "01-intro.md". No need for relative paths in the link.

ERROR:root:In ./index.md: The linked page 01-intro.html exists, but the link text 'Analyzing Patient Data' does not match the (sub)title of that page, ''.

When you link to a markdown file from index.md, the link text should match the "subtitle" of the page. This is to confirm that you are linking to what you think you are.

Full log of all errors

ERROR:root:In ./01-intro.md: The topic page should not have sub-headings outside of special blocks. If a topic needs sub-headings, it should be broken into multiple topics.
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: MATLAB GUI
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Loading Data
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Understanding Assignment
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: MATLAB Arrays
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Accessing Array Elements
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Computing With Arrays
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Plotting
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Wrapping up
WARNING:root:In ./01-intro.md: The following sub-heading should be removed: Next Steps
ERROR:root:In ./01-intro.md: Learning Objectives should not be empty.
WARNING:root:In ./01-intro.md: Unrecognized label in header section: root
ERROR:root:In ./01-intro.md: Heading at line 45 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 57 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 154 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 262 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 275 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 336 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 523 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 544 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 790 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 865 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 871 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 920 should be level 2
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: MATLAB GUI
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Loading Data
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Understanding Assignment
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: MATLAB Arrays
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Accessing Array Elements
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Computing With Arrays
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Plotting
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Wrapping up
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Next Steps
ERROR:root:In ./01-intro.md: Heading at line 45 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 57 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 154 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 262 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 275 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 336 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 523 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 544 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 790 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 865 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 871 should be level 2
ERROR:root:In ./01-intro.md: Heading at line 920 should be level 2
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: MATLAB GUI
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Loading Data
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Understanding Assignment
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: MATLAB Arrays
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Accessing Array Elements
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Computing With Arrays
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Plotting
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Wrapping up
ERROR:root:In ./01-intro.md: Document contains heading not specified in the template: Next Steps
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#comma-separated-values in ./../../gloss.html#comma-separated-values. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#current-working-directory in ./../../gloss.html#current-working-directory. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#function-call in ./../../gloss.html#function-call. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#parameter in ./../../gloss.html#parameter. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#string in ./../../gloss.html#string. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#variable in ./../../gloss.html#variable. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#shape in ./../../gloss.html#shape. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#index in ./../../gloss.html#index. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#slice in ./../../gloss.html#slice. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#stride in ./../../gloss.html#stride. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./01-intro.md: Could not find the linked asset file ../../gloss.html#slice in ./../../gloss.html#slice. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./02-loop.md: The topic page should not have sub-headings outside of special blocks. If a topic needs sub-headings, it should be broken into multiple topics.
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Objectives
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Saving Our Work
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Writing Scripts
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Saving Images
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: The Colon Operator
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Analyzing Multiple Datasets
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: for loops
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Processing Multiple Files
WARNING:root:In ./02-loop.md: The following sub-heading should be removed: Challenges
ERROR:root:In ./02-loop.md: Learning Objectives should not be empty.
WARNING:root:In ./02-loop.md: Unrecognized label in header section: root
ERROR:root:In ./02-loop.md: Heading at line 45 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 60 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 62 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 113 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 172 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 208 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 216 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 410 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 474 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 621 should be level 2
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Objectives
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Saving Our Work
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Writing Scripts
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Saving Images
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: The Colon Operator
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Analyzing Multiple Datasets
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: for loops
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Processing Multiple Files
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./02-loop.md: Heading at line 45 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 60 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 62 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 113 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 172 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 208 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 216 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 410 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 474 should be level 2
ERROR:root:In ./02-loop.md: Heading at line 621 should be level 2
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Objectives
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Saving Our Work
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Writing Scripts
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Saving Images
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: The Colon Operator
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Analyzing Multiple Datasets
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: for loops
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Processing Multiple Files
ERROR:root:In ./02-loop.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./02-loop.md: Could not find the linked asset file ../../gloss.html#for-loop in ./../../gloss.html#for-loop. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./02-loop.md: Could not find the linked asset file ../../gloss.html#loop-body in ./../../gloss.html#loop-body. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./02-loop.md: Could not find the linked asset file ../../gloss.html#loop-variable in ./../../gloss.html#loop-variable. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./02-loop.md: Could not find the linked asset file ../../gloss.html#stride in ./../../gloss.html#stride. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./02-loop.md: Could not find the linked asset file ../../gloss.html#wildcard in ./../../gloss.html#wildcard. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./03-func.md: The topic page should not have sub-headings outside of special blocks. If a topic needs sub-headings, it should be broken into multiple topics.
WARNING:root:In ./03-func.md: The following sub-heading should be removed: Defining a Function
WARNING:root:In ./03-func.md: The following sub-heading should be removed: Composing Functions
WARNING:root:In ./03-func.md: The following sub-heading should be removed: Challenges 
WARNING:root:In ./03-func.md: The following sub-heading should be removed: The Call Stack
WARNING:root:In ./03-func.md: The following sub-heading should be removed: Testing and Documentation
WARNING:root:In ./03-func.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./03-func.md: The following sub-heading should be removed: Next Steps
ERROR:root:In ./03-func.md: Learning Objectives should not be empty.
WARNING:root:In ./03-func.md: Unrecognized label in header section: root
ERROR:root:In ./03-func.md: Heading at line 27 should be level 2
ERROR:root:In ./03-func.md: Heading at line 97 should be level 2
ERROR:root:In ./03-func.md: Heading at line 158 should be level 2
ERROR:root:In ./03-func.md: Heading at line 206 should be level 2
ERROR:root:In ./03-func.md: Heading at line 227 should be level 2
ERROR:root:In ./03-func.md: Heading at line 361 should be level 2
ERROR:root:In ./03-func.md: Heading at line 392 should be level 2
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Defining a Function
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Composing Functions
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Challenges 
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: The Call Stack
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Testing and Documentation
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Next Steps
ERROR:root:In ./03-func.md: Heading at line 27 should be level 2
ERROR:root:In ./03-func.md: Heading at line 97 should be level 2
ERROR:root:In ./03-func.md: Heading at line 158 should be level 2
ERROR:root:In ./03-func.md: Heading at line 206 should be level 2
ERROR:root:In ./03-func.md: Heading at line 227 should be level 2
ERROR:root:In ./03-func.md: Heading at line 361 should be level 2
ERROR:root:In ./03-func.md: Heading at line 392 should be level 2
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Defining a Function
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Composing Functions
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Challenges 
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: The Call Stack
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Testing and Documentation
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./03-func.md: Document contains heading not specified in the template: Next Steps
ERROR:root:In ./03-func.md: Could not find the linked asset file ../../gloss.html#function-composition in ./../../gloss.html#function-composition. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./03-func.md: Could not find the linked asset file ../../gloss.html#documentation in ./../../gloss.html#documentation. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./04-cond.md: The topic page should not have sub-headings outside of special blocks. If a topic needs sub-headings, it should be broken into multiple topics.
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Conditionals
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Nesting
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Creating a Heat Map
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./04-cond.md: The following sub-heading should be removed: Next Steps
ERROR:root:In ./04-cond.md: Learning Objectives should not be empty.
WARNING:root:In ./04-cond.md: Unrecognized label in header section: root
ERROR:root:In ./04-cond.md: Heading at line 14 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 130 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 195 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 270 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 291 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 470 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 499 should be level 2
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Conditionals
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Nesting
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Creating a Heat Map
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Next Steps
ERROR:root:In ./04-cond.md: Heading at line 14 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 130 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 195 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 270 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 291 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 470 should be level 2
ERROR:root:In ./04-cond.md: Heading at line 499 should be level 2
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Conditionals
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Nesting
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Creating a Heat Map
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./04-cond.md: Document contains heading not specified in the template: Next Steps
ERROR:root:In ./04-cond.md: Could not find the linked asset file ../../gloss.html#conditional-statement in ./../../gloss.html#conditional-statement. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./04-cond.md: Could not find the linked asset file ../../gloss.html#in-place-operator in ./../../gloss.html#in-place-operator. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./04-cond.md: Could not find the linked asset file ../../gloss.html#colormap in ./../../gloss.html#colormap. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: The topic page should not have sub-headings outside of special blocks. If a topic needs sub-headings, it should be broken into multiple topics.
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Defensive Programming
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Objectives
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Assertions
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Test-Driven Development
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Challenges
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Debugging
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Know What It's Supposed to Do
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Make It Fail Every Time
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Make It Fail Fast
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Change One Thing at a Time, For a Reason
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Keep Track of What You've Done
WARNING:root:In ./05-defensive.md: The following sub-heading should be removed: Be Humble
ERROR:root:In ./05-defensive.md: Learning Objectives should not be empty.
WARNING:root:In ./05-defensive.md: Unrecognized label in header section: root
ERROR:root:In ./05-defensive.md: Heading at line 29 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 39 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 216 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 224 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 332 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 346 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 359 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 426 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 450 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 477 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 501 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 532 should be level 2
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Defensive Programming
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Objectives
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Assertions
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Test-Driven Development
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Debugging
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Know What It's Supposed to Do
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Make It Fail Every Time
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Make It Fail Fast
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Change One Thing at a Time, For a Reason
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Keep Track of What You've Done
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Be Humble
ERROR:root:In ./05-defensive.md: Heading at line 29 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 39 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 216 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 224 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 332 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 346 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 359 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 426 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 450 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 477 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 501 should be level 2
ERROR:root:In ./05-defensive.md: Heading at line 532 should be level 2
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Defensive Programming
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Objectives
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Assertions
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Test-Driven Development
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Challenges
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Debugging
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Know What It's Supposed to Do
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Make It Fail Every Time
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Make It Fail Fast
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Change One Thing at a Time, For a Reason
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Keep Track of What You've Done
ERROR:root:In ./05-defensive.md: Document contains heading not specified in the template: Be Humble
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#defensive-programming in ./../../gloss.html#defensive-programming. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#assertion in ./../../gloss.html#assertion. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#precondition in ./../../gloss.html#precondition. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#fail-early-fail-often in ./../../rules.html#fail-early-fail-often. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#turn-bugs-into-assertions-or-tests in ./../../rules.html#turn-bugs-into-assertions-or-tests. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#regression in ./../../gloss.html#regression. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#test-driven-development in ./../../gloss.html#test-driven-development. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#know-what-its-supposed-to-do in ./../../rules.html#know-what-its-supposed-to-do. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#test-oracle in ./../../gloss.html#test-oracle. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: The linked page 01-intro.html exists, but the link text 'opening lesson' does not match the (sub)title of that page, ''.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#make-it-fail-every-time in ./../../rules.html#make-it-fail-every-time. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#make-it-fail-fast in ./../../rules.html#make-it-fail-fast. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#change-one-thing-at-a-time in ./../../rules.html#change-one-thing-at-a-time. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../gloss.html#regression in ./../../gloss.html#regression. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#keep-track-of-what-youve-done in ./../../rules.html#keep-track-of-what-youve-done. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#be-humble in ./../../rules.html#be-humble. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./05-defensive.md: Could not find the linked asset file ../../rules.html#week-hard-work-hour-thought in ./../../rules.html#week-hard-work-hour-thought. If this is a URL, it must be prefixed with http(s):// or ftp://.
ERROR:root:In ./index.md: Intro should contain a blockquoted section with level 2 title 'Prerequisites'. Section should not be empty.
WARNING:root:In ./index.md: Unrecognized label in header section: root
ERROR:root:In ./index.md: Document is missing expected heading: Topics
ERROR:root:In ./index.md: Document is missing expected heading: Other Resources
ERROR:root:In ./index.md: Document is missing expected heading: Topics
ERROR:root:In ./index.md: Document is missing expected heading: Other Resources
ERROR:root:In ./index.md: The linked page 01-intro.html exists, but the link text 'Analyzing Patient Data' does not match the (sub)title of that page, ''.
ERROR:root:In ./index.md: The linked page 02-loop.html exists, but the link text 'Reusing Code' does not match the (sub)title of that page, ''.
ERROR:root:In ./index.md: The linked page 03-func.html exists, but the link text 'Creating Functions' does not match the (sub)title of that page, ''.
ERROR:root:In ./index.md: The linked page 04-cond.html exists, but the link text 'Making Choices' does not match the (sub)title of that page, ''.
WARNING:root:Some errors were encountered during validation. See log for details.

from matlab-novice-inflammation.

shwina avatar shwina commented on May 29, 2024

@abought
Thanks so much. Will work on all this right away. :)

from matlab-novice-inflammation.

abought avatar abought commented on May 29, 2024

Incidentally, you can run the validator on one file at a time to make the changelist more manageable. I'll look forward to seeing the updated lesson in all its glory!

from matlab-novice-inflammation.

shwina avatar shwina commented on May 29, 2024

@abought

Awesome! That's useful to know. I'll update you once we're there. Thanks for all your work :-)

from matlab-novice-inflammation.

gvwilson avatar gvwilson commented on May 29, 2024

Thank you both very much for this - it's tremendously helpful.

from matlab-novice-inflammation.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.