Repository navigation
docs: Add markdown file for FileSystemWatcherMock #926
Description
Add a Readme.md/FileSystemWatcherMock.md which contains the explanation for Renamed events covered in #919. This is more of a nice-to-have, the behavior could be inferred from the code, but a table on what happens when would be nice for future changes to easily compare what fails and why.
@vbreuss what do think? And where would be the best place to have the markdown? I would've just placed it next FileSystemWatcherMock.cs with the name FileSystemWatcherMock.md
Activity
vbreuss commentedon Jan 29, 2026
I would prefer not to mix source files and documentation.
Instead I suggest to either
Docsfolder where I already put some usage examples and document a high-level behavior description of the FileSystemWatcher there orFileSystemWatcherexample where you could also put concrete code samplesThe latter is also linked from the main README.md file:
pw-sgr commentedon Jan 29, 2026
I wouldn't mix in documentation for the maintainers into user documentation, maybe we do
Docs/MaintainerorDocs/SourceCodeor something along those lines?vbreuss commentedon Jan 29, 2026
Ah, you think of a documentation for maintainers.
Then I would suggest the following:
FileSystemWatcherpw-sgr commentedon Jan 29, 2026
Okay, will do.