docs: added maintainer documentation with FileSystemWatcherMock#928
Merged
vbreuss merged 3 commits intoTestably:mainfrom Jan 30, 2026
Merged
Conversation
Contributor
Author
|
@vbreuss added the general outline and the mentioned events for the watcher. Maintainer.md will link to the individual mocks and have general documentation. |
There was a problem hiding this comment.
Pull request overview
This PR adds maintainer documentation for the FileSystemWatcherMock implementation, documenting platform-specific behavior differences for file system events across Linux, Windows, and macOS.
Changes:
- Added comprehensive documentation tables showing FileSystemWatcher event behavior across different platforms
- Created maintainer documentation structure in the Docs folder
- Linked documentation from CONTRIBUTING.md and FileSystemWatcherMock class
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Docs/FileSystemWatcherMock.md | Documents event behavior tables for FileSystemWatcher across platforms with and without subdirectory inclusion |
| Docs/Maintainer.md | Creates maintainer documentation index linking to implementation details |
| CONTRIBUTING.md | Adds reference to maintainer documentation for developers |
| Source/Testably.Abstractions.Testing/FileSystem/FileSystemWatcherMock.cs | Adds XML documentation remarks linking to the FileSystemWatcherMock documentation |
| Testably.Abstractions.sln | Includes new documentation files in the solution under the Docs project section |
Source/Testably.Abstractions.Testing/FileSystem/FileSystemWatcherMock.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
vbreuss
approved these changes
Jan 30, 2026
|
This is addressed in release v5.1.0. |
This was referenced Feb 2, 2026
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#926