Skip to content

Commit 55777b9

Browse files
🩹 [Patch]: Add missing description in Get-AstFunctionName documentation (#29)
## Description This pull request includes minor configuration and documentation updates. The changes adjust markdown linting rules to allow duplicate headings in different sections and clarify a comment in a PowerShell script. Markdown linting configuration updates: * [`.github/linters/.markdown-lint.yml`](diffhunk://#diff-2fd3619d2b7372123257bc21645edb90c24293e66babbc6053033a89e21bab34R16-R19): Enabled the `MD024` rule with `siblings_only: true` to allow duplicate headings in different sections, and fixed a minor formatting issue in the `MD026` rule's punctuation list. Documentation update: * [`src/functions/public/Functions/Get-AstFunctionName.ps1`](diffhunk://#diff-2ee3ffd01095ba14809bc564e9a20a88019e8de468caf6d710c405ef9d5a44ffR47-R48): Added a placeholder description comment in the documentation section.
1 parent 6091e56 commit 55777b9

3 files changed

Lines changed: 21 additions & 9 deletions

File tree

‎.github/PSModule.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,12 @@ Test:
1919
# Build:
2020
# Docs:
2121
# Skip: true
22+
Linter:
23+
env:
24+
VALIDATE_BIOME_FORMAT: false
25+
VALIDATE_BIOME_LINT: false
26+
VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
27+
VALIDATE_JSCPD: false
28+
VALIDATE_JSON_PRETTIER: false
29+
VALIDATE_MARKDOWN_PRETTIER: false
30+
VALIDATE_YAML_PRETTIER: false

‎.github/linters/.markdown-lint.yml‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,20 @@
88
###############
99
# Rules by id #
1010
###############
11-
MD004: false # Unordered list style
11+
MD004: false # Unordered list style
1212
MD007:
13-
indent: 2 # Unordered list indentation
13+
indent: 2 # Unordered list indentation
1414
MD013:
15-
line_length: 808 # Line length
15+
line_length: 808 # Line length
16+
MD024:
17+
siblings_only: true # Allow duplicate headings in different sections
1618
MD026:
17-
punctuation: ".,;:!。,;:" # List of not allowed
18-
MD029: false # Ordered list item prefix
19-
MD033: false # Allow inline HTML
20-
MD036: false # Emphasis used instead of a heading
19+
punctuation: '.,;:!。,;:' # List of not allowed
20+
MD029: false # Ordered list item prefix
21+
MD033: false # Allow inline HTML
22+
MD036: false # Emphasis used instead of a heading
2123

2224
#################
2325
# Rules by tags #
2426
#################
25-
blank_lines: false # Error on blank lines
27+
blank_lines: false # Error on blank lines

‎src/functions/public/Functions/Get-AstFunctionName.ps1‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,14 @@
4444
.OUTPUTS
4545
System.String
4646
47+
The names of functions found in the PowerShell script.
48+
4749
.NOTES
4850
The name of each function found in the PowerShell script.
4951
5052
.LINK
5153
https://psmodule.io/Ast/Functions/Functions/Get-AstFunctionName/
5254
#>
53-
5455
[CmdletBinding()]
5556
param (
5657
# The name of the command to search for. Defaults to all commands ('*').

0 commit comments

Comments
 (0)