Skip to content

Commit

Permalink
docs: improve documentation markup
Browse files Browse the repository at this point in the history
  • Loading branch information
Erick2280 committed Sep 17, 2024
1 parent 5e72cba commit b814c08
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/parsing/swift-file-tree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export class SwiftFileTree {
return [];
}

// A SwiftUI view is a property declaration with an opaque type annotation that matches "some View".
// A SwiftUI view is a property declaration with an opaque type annotation that matches `some View`.
const swiftUIViewQueryText = `
(
(property_declaration
Expand All @@ -119,7 +119,7 @@ export class SwiftFileTree {

/**
* Replace the text in the tree with the given replacement text.
* Prefer using `replaceNode` instead of this method, which uses this one under the hood.
* Prefer using {@link replaceNode} instead of this method, which uses this one under the hood.
*/
replaceText(
originalStart: Point,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
} from '../fault-transformation-rule.js';

/**
* This rule matches to a SwiftUI View element with a `.accessibilityHidden` modifier, which
* This rule matches to a SwiftUI view element with a `.accessibilityHidden` modifier, which
* is used to hide views with decorative or repetitive content from screen readers. The transformation
* removes the modifier.
*
Expand Down
2 changes: 1 addition & 1 deletion src/transforming/rules/accessibility-modifier-remover.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
} from '../fault-transformation-rule.js';

/**
* This rule matches to a SwiftUI View element with a `.accessibility` modifier, which
* This rule matches to a SwiftUI view element with a `.accessibility` modifier, which
* is used to provide a text alternative for screen reader users to a view that doesn't
* display text. The transformation removes the label.
*
Expand Down

0 comments on commit b814c08

Please sign in to comment.