-
-
Notifications
You must be signed in to change notification settings - Fork 12
docs: added maintainer documentation with FileSystemWatcherMock #928
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
docs: added maintainer documentation with FileSystemWatcherMock #928
Conversation
|
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
vbreuss
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @pw-sgr
|
This is addressed in release v5.1.0. |
#926