Skip to content

Improve Help & Docs#5

Merged
HeyItsGilbert merged 3 commits intomainfrom
Help
May 28, 2025
Merged

Improve Help & Docs#5
HeyItsGilbert merged 3 commits intomainfrom
Help

Conversation

@HeyItsGilbert
Copy link
Owner

@HeyItsGilbert HeyItsGilbert commented May 28, 2025

Added

  • Added comment based help on private functions to make it easier for new
    contributors to grok.

Changed

  • Formatted all the functions to stay under 80 character line limit. This is a
    preference. We will have a 120 hard limit (when possible).

* Added comment-based help to several functions to improve documentation.
* Enhanced user experience for new contributors by providing clear usage examples.
* Updated `CHANGELOG.md` to reflect these additions.
@HeyItsGilbert HeyItsGilbert changed the title Unreleased Improve Help & Docs May 28, 2025
@github-actions
Copy link

github-actions bot commented May 28, 2025

Test Results

 3 files  27 suites   1s ⏱️
31 tests 29 ✅ 2 💤 0 ❌
93 runs  87 ✅ 6 💤 0 ❌

Results for commit 1f5b8aa.

♻️ This comment has been updated with latest results.

Gilbert Sanchez added 2 commits May 28, 2025 07:53
…ction

- Enhanced the function documentation with a comprehensive `.SYNOPSIS`, `.DESCRIPTION`, and `.EXAMPLE`.
- Improved readability and usability of the shortcut keys panel for the Pester Explorer TUI.
@HeyItsGilbert HeyItsGilbert merged commit 246414e into main May 28, 2025
6 checks passed
@HeyItsGilbert HeyItsGilbert deleted the Help branch May 28, 2025 19:13
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