Skip to content

Fix documentation typos and add missing Oxford commas#206

Merged
schuyler merged 1 commit intomainfrom
issue-108-documentation-fixes
Dec 7, 2025
Merged

Fix documentation typos and add missing Oxford commas#206
schuyler merged 1 commit intomainfrom
issue-108-documentation-fixes

Conversation

@schuyler
Copy link
Copy Markdown
Owner

@schuyler schuyler commented Dec 7, 2025

Summary

Applies minor documentation fixes based on PR #1272 from upstream MacDown, plus additional typo fixes found during review.

Changes

MacDown/Resources/contribute.md (from PR #1272)

  • Added Oxford comma: "read through the issues, and start contributing"
  • Added Oxford comma: "documentation, translation, and support"

MacDown/Resources/help.md

  • Fixed grammar: "a easy-to-read" → "an easy-to-read"
  • Fixed contraction: "Lets" → "Let's"
  • Fixed possessive: "it's own line" → "its own line" (3 occurrences)

assets/demo.md

  • Fixed typo: "grammer" → "grammars"

CONTRIBUTING.md

  • Fixed typo: "ommitted" → "omitted"
  • Fixed typo: "Stetements" → "Statements"
  • Fixed typo: "ambiguious" → "ambiguous"
  • Fixed typo: "appriciate" → "appreciate"

Related Issue

Related to #108

Manual Testing Plan

N/A - documentation-only changes

Review Notes

No code changes, only documentation fixes.

@schuyler
Fix documentation typos and add missing Oxford commas
fb06415 
Changes based on PR MacDownApp/macdown#1272 plus additional fixes:

- contribute.md: Add Oxford commas in two list items
- help.md: Fix "a easy" → "an easy", "Lets" → "Let's",
  "it's" → "its" (possessive)
- demo.md: Fix "grammer" → "grammars"
- CONTRIBUTING.md: Fix typos "ommitted", "Stetements",
  "ambiguious", "appriciate"

Related to #108
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 7, 2025 •
edited
Loading

Code Coverage Report

Current Coverage: 36.75%

Coverage Details (Summary) 
Name                                                                                                                                   Coverage            
-------------------------------------------------------------------------------------------------------------------------------------- ------------------- 
MASPreferences.bundle                                                                                                                  0.00% (0/0)         
MacDown 3000.app                                                                                                                       42.48% (5267/12398) 
    /Users/runner/work/macdown3000/macdown3000/MacDown/Code/Extension/NSColor+HTML.m                                                   94.05% (332/353)    
        +[NSColor(HTML) colorWithHexString:]                                                                                           94.12% (16/17)      
        +[NSColor(HTML) colorWithHTMLName:]                                                                                            89.13% (164/184)    
        __35+[NSColor(HTML) colorWithHTMLName:]_block_invoke                                                                           100.00% (152/152)   
    /Users/runner/work/macdown3000/macdown3000/MacDown/Code/Preferences/MPHtmlPreferencesViewController.m                              0.00% (0/87)        
        MPPrismDefaultThemeName                                                                                                        0.00% (0/2)         
        -[MPHtmlPreferencesViewController viewIdentifier]                                                                              0.00% (0/3)         
        -[MPHtmlPreferencesViewController toolbarItemImage]                                                                            0.00% (0/3)         
        -[MPHtmlPreferencesViewController toolbarItemLabel]                                                                            0.00% (0/2)         
        -[MPHtmlPreferencesViewController viewWillAppear]                                                                              0.00% (0/4)         
        -[MPHtmlPreferencesViewController changeStylesheet:]                                                                           0.00% (0/7)         
        -[MPHtmlPreferencesViewController changeHighlightingTheme:]                                                                    0.00% (0/7)         
        -[MPHtmlPreferencesViewController invokeStylesheetFunction:]                                                                   0.00% (0/23)        
        -[MPHtmlPreferencesViewController loadStylesheets]                                                                             0.00% (0/13)        
        -[MPHtmlPreferencesViewController loadHighlightingThemes]                                                                      0.00% (0/23)        
    /Users/runner/work/macdown3000/macdown3000/Dependency/peg-markdown-highlight/HGMarkdownHighlightingStyle.m                         87.69% (57/65)      
        +[HGMarkdownHighlightingStyle colorFromARGBColor:]                                                                             100.00% (6/6)       
        -[HGMarkdownHighlightingStyle initWithType:attributesToAdd:toRemove:fontTraitsToAdd:]                                          88.89% (8/9)        
        -[HGMarkdownHighlightingStyle initWithStyleAttributes:baseFont:]                                                               86.00% (43/50)      
    /Users/runner/work/macdown3000/macdown3000/MacDown/Code/Extension/hoedown_html_patch.c                                             73.64% (95/129)     
        hoedown_patch_render_blockcode                                                                                                 89.09% (49/55)      
        hoedown_patch_render_listitem                                                                                                  100.00% (46/46)     
        hoedown_patch_render_toc_header                                                                                                0.00% (0/28)        
    /Users/runner/work/macdown3000/macdown3000/MacDown/Code/Application/MPMainController.m                                             40.76% (97/238)     
        MPOpenBundledFile                                                                                                              95.24% (20/21)      
        __MPOpenBundledFile_block_invoke                                                                                               85.71% (6/7)        
        treat                                                                                                                          20.00% (6/30)       
        __treat_block_invoke                                                                                                           0.00% (0/3)         
        -[MPMainController applicationDidFinishLaunching:]                                                                             100.00% (6/6)       
        -[MPMainController openUrlSchemeAppleEvent:withReplyEvent:]                                                                    0.00% (0/45)        
        __59-[MPMainController openUrlSchemeAppleEvent:withReplyEvent:]_block_invoke                                                   0.00% (0/7)         
        -[MPMainController valueForKey:fromQueryItems:]                                                                                0.00% (0/5)         
        -[MPMainController preferences]                                                                                                100.00% (3/3)       
        -[MPMainController preferencesWindowController]                                                                                0.00% (0/18)        
        -[MPMainController showPreferencesWindow:]                                                                                     0.00% (0/2)         
        -[MPMainController showHelp:]                                                                                                  100.00% (3/3)       
        -[MPMainController showContributing:]                                                                                          100.00% (3/3)       
        -[MPMainController init]                                                                                                       90.91% (10/11)      
        -[MPMainController applicationShouldOpenUntitledFile:]                                                                         80.00% (4/5)        
        -[MPMainController applicationDidBecomeActive:]                                                                                100.00% (5/5)       
        -[MPMainController copyFiles]                                                                                                  63.33% (19/30)      
        -[MPMainController openPendingFiles]                                                                                           29.41% (5/17)       
        -[MPMainController openPendingPipedContent]                                                                                    28.57% (4/14)       
        -[MPMainController showFirstLaunchTips]                                                                                        100.00% (3/3)       
    /Users/runner/work/macdown3000/macdown3000/MacDown/Code/Utility/MPUtilities.m                                                      63.12% (101/160)    
        MPDataRootDirectory                                                                                                            100.00% (14/14)     

... (2111 more lines truncated)

📊 **Full coverage report available in workflow artifacts**

@schuyler schuyler merged commit d7bce3d into main Dec 7, 2025
4 checks passed
@schuyler schuyler deleted the issue-108-documentation-fixes branch December 7, 2025 01:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@schuyler