Fix doc comments in Process.fs#2885
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates XML doc comments in Fake.Core.Process’s Shell API to match the actual optional parameter name (dir) and fixes a small grammar issue in the summary text.
Changes:
- Update
<param>name fromdirectorytodirforShell.ExecandShell.AsyncExec. - Fix “it’s completion” → “its completion” in the
Shell.Execsummary.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Are there any relevant comments from Copilot? |
|
I wasn't looking at anything other than the param names before, but looking at the code now the 'async' function doesn't look very async? (actually it looks the same as the implementation of the not-async version) |
|
Yep so I think we should get rid of that |
It doesn't seem to be used from anywhere in this repo at least: Numpsy@4c91022 So remove in v8 maybe |
The Exec functions have a parameter called 'dir' but the doc comments have 'directory', so this just makes them consistent
The Exec functions have a parameter called 'dir' but the doc comments have 'directory', so this just makes them consistent
(Just noticed a warning in Rider when looking at #2880 and though they should be consistent)