Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🩹 [Patch]: Enhance documentation for functions #37

Merged
merged 2 commits into from
Feb 14, 2025
Merged

Conversation

MariusStorhaug
Copy link
Member

@MariusStorhaug MariusStorhaug commented Feb 14, 2025

Description

This pull request includes significant updates to the font management functions in the PowerShell module, enhancing their functionality and documentation. The key changes include improved descriptions, added examples with outputs, and support for additional parameters.

Enhancements to Get-Font function:

  • Updated the description to clarify the retrieval of installed fonts with support for filtering by font name using wildcards.
  • Added example outputs to illustrate the function's usage and expected results.
  • Included detailed notes on the returned font object properties and a link to the function's documentation.

Enhancements to Install-Font function:

  • Improved the description to include details on scope, force installation, and batch installations via pipeline input.
  • Added example outputs to demonstrate the function's behavior in different scenarios, including single file and batch installations.
  • Changed the Scope parameter type from Scope[] to string for better clarity and usage.
  • Included notes on the function's outputs and a link to the documentation.

Enhancements to Uninstall-Font function:

  • Updated the description to include support for removing fonts for either the current user or all users, with administrative privileges required for the latter.
  • Added example outputs to show the verbose logging during font uninstallation.
  • Included notes on the function's behavior and a link to the documentation.

Type of change

  • 📖 [Docs]
  • 🪲 [Fix]
  • 🩹 [Patch]
  • ⚠️ [Security fix]
  • 🚀 [Feature]
  • 🌟 [Breaking change]

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas

@MariusStorhaug MariusStorhaug self-assigned this Feb 14, 2025
@MariusStorhaug MariusStorhaug requested a review from a team as a code owner February 14, 2025 09:29
@MariusStorhaug MariusStorhaug merged commit 4c13d1f into main Feb 14, 2025
20 checks passed
@MariusStorhaug MariusStorhaug deleted the fixDocs branch February 14, 2025 09:43
Copy link

Module Fonts - v1.1.15 published to the PowerShell Gallery.

Copy link

GitHub release for Fonts v1.1.15 has been created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant