Skip to content

Commit 74c9b0f

Browse files
🩹 [Patch]: Update required modules + doc links (#37)
## Description This pull request includes updates to the `NerdFonts` PowerShell module, focusing on documentation enhancements, dependency updates, and compatibility improvements. Below are the most important changes: ### Documentation Enhancements: * Added `.LINK` and `.NOTES` sections to `Get-NerdFont` and `Install-NerdFont` functions, providing links to the official NerdFonts documentation and GitHub repository for better user guidance. (`src/functions/public/Get-NerdFont.ps1` [[1]](diffhunk://#diff-b3f6234dd4f55afe9de8daa4a7b43d8e17df21dbf18f9b96e2a32a950a1699caR23-R30) `src/functions/public/Install-NerdFont.ps1` [[2]](diffhunk://#diff-805a4a6beeb97eef72e8ff0b1bb90dee541f9da03df2803ab0a42416e5a8e794R31-R38) ### Dependency Updates: * Updated the required version of the `Fonts` module from `1.1.19` to `1.1.21` and added a new dependency on the `Admin` module with version `1.1.6` in the `Install-NerdFont` function. (`src/functions/public/Install-NerdFont.ps1` [src/functions/public/Install-NerdFont.ps1L1-R2](diffhunk://#diff-805a4a6beeb97eef72e8ff0b1bb90dee541f9da03df2803ab0a42416e5a8e794L1-R2)) ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 95a4960 commit 74c9b0f

3 files changed

Lines changed: 16 additions & 4 deletions

File tree

src/functions/public/Get-NerdFont.ps1

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@
2020
Get-NerdFonts -Name '*Code'
2121
2222
Get the NerdFont with the name ending with 'Code'.
23+
24+
.LINK
25+
https://psmodule.io/NerdFonts/Functions/Get-NerdFont
26+
27+
.NOTES
28+
More information about the NerdFonts can be found at:
29+
[NerdFonts](https://www.nerdfonts.com/) | [GitHub](https://github.com/ryanoasis/nerd-fonts)
2330
#>
2431
[Alias('Get-NerdFonts')]
2532
[OutputType([System.Object[]])]

src/functions/public/Install-NerdFont.ps1

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
#Requires -Modules @{ ModuleName = 'Fonts'; RequiredVersion = '1.1.19' }
1+
#Requires -Modules @{ ModuleName = 'Fonts'; RequiredVersion = '1.1.21' }
2+
#Requires -Modules @{ ModuleName = 'Admin'; RequiredVersion = '1.1.6' }
23

34
function Install-NerdFont {
45
<#
@@ -27,6 +28,13 @@ function Install-NerdFont {
2728
Install-NerdFont -All
2829
2930
Installs all Nerd Fonts to the current user.
31+
32+
.LINK
33+
https://psmodule.io/NerdFonts/Functions/Install-NerdFont
34+
35+
.NOTES
36+
More information about the NerdFonts can be found at:
37+
[NerdFonts](https://www.nerdfonts.com/) | [GitHub](https://github.com/ryanoasis/nerd-fonts)
3038
#>
3139
[CmdletBinding(
3240
DefaultParameterSetName = 'ByName',

src/manifest.psd1

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)