TOP003/004: Make Additional Resources section optional #30402
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removed several helper "addError" functions - unnecessary abstractions for our limited use case (more useful for library source code covering many more rules). Some conditions restructured to reduce nesting noise. More refactoring could be done but for now, not particularly significant, and this should already be much easier to parse and maintain.
No strong reason to allow separate post-assignment sections since they should be workable prior to or within the assignment. Headings within an assignment panel must be level 4 since the assignment heading is level 3.
Fixed non-TOP004 lint errors. Ensured all sections and headings reflect desired structures in lessons/projects (e.g. remove any full sections after the assignment in projects)
Additional resources will be optional - "?" feature needs demonstrating
Hopefully the refactored final missing headings conditional is a little less unwieldy for now.
Empty AR section no longer allowed - section should not exist if empty. TOP003 valid test added, which also demonstrates no errors if AR section is missing.
github-actions
bot
added
the
Content: Markdownlint
mao-sz
changed the title
Member
|
Hi @mao-sz , I've requested a review from Eric since I believe he's well versed in our linter setup too. I think I saw you discussing this change with Carlos too however, so feel free to add him to the review list if you believe that's valuable. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
See #30385 for more details about the current Additional Resources initiative.
Making the section optional in the TOP004 lint rule will pave the way for empty AR sections to be removed entirely, and allow the team to start evaluating existing ARs and decide on a plan of action.
Lint errors flagged are intentional as part of the relevant test files (please check the errors are what would be expected).
This PR
'?'syntax used for optional AR - should be easy to handle dropping or otherwise changing the intent of the AR section in the future.Issue
Related to #30385
Closes #30386
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection