Skip to content

Commit 90a5cdb

Browse files
🩹 [Patch]: Update required modules + doc links (#49)
## Description This pull request introduces updates to improve documentation for PowerShell functions, update module dependencies, and clean up the project manifest. Below is a breakdown of the most significant changes: ### Documentation Enhancements: * Added `.LINK` and `.NOTES` sections to the `Get-GoogleFont` function to provide additional resources and context, including links to the function's documentation and the Google Fonts GitHub repository. (`src/functions/public/Get-GoogleFont.ps1`, [src/functions/public/Get-GoogleFont.ps1R23-R29](diffhunk://#diff-86091f30b4dfb1604e5f505f18809aad419502a27c58272d2eb24defcacf6b37R23-R29)) * Added `.LINK` and `.NOTES` sections to the `Install-GoogleFont` function for similar purposes, enhancing the function's usability and clarity. (`src/functions/public/Install-GoogleFont.ps1`, [src/functions/public/Install-GoogleFont.ps1R31-R37](diffhunk://#diff-f926b03377b12f05eed72cf360452ff4ac9b8f4a2c7c858e02068ea43cc050a5R31-R37)) ### 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 a required version of `1.1.6`, ensuring compatibility and new functionality. (`src/functions/public/Install-GoogleFont.ps1`, [src/functions/public/Install-GoogleFont.ps1L1-R2](diffhunk://#diff-f926b03377b12f05eed72cf360452ff4ac9b8f4a2c7c858e02068ea43cc050a5L1-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 e0e7c47 commit 90a5cdb

3 files changed

Lines changed: 16 additions & 4 deletions

File tree

src/functions/public/Get-GoogleFont.ps1

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

src/functions/public/Install-GoogleFont.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-GoogleFont {
45
<#
@@ -27,6 +28,13 @@ function Install-GoogleFont {
2728
Install-GoogleFont -All
2829
2930
Installs all Google Fonts to the current user.
31+
32+
.LINK
33+
https://psmodule.io/GoogleFonts/Functions/Install-GoogleFont
34+
35+
.NOTES
36+
More information about the GoogleFonts can be found at:
37+
[GoogleFonts](https://fonts.google.com/) | [GitHub](https://github.com/google/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)