Cleanup vs ext 2 #358
Cleanup vs ext 2 #358
Conversation
| @@ -14,7 +14,6 @@ | |||
| using Microsoft.VisualStudio.FSharp.LanguageService.Resources; | |||
|
|
|||
| namespace Microsoft.VisualStudio.FSharp.LanguageService { | |||
| /// <include file='doc\CodeWindowManager.uex' path='docs/doc[@for="CodeWindowManager"]/*' /> | |||
There was a problem hiding this comment.
I have sent a question to our MSDN doc team about whether this will break, internal doc generation tooling. My suspicion is that these comments are necessary. But I honestly don't know.
*** Update ****
Got the word back from the msdn doc guys, they don't recognize any of the files, so they believe it's safe to make these changes.
In some ways that's the problem with all of this clean up, it is certainly needed but there are more teams that depend on, and can make changes to this codebase than just us. That's not to say it isn't worth finding out, however, inadvertently breaking or even worse silently braking a bunch of teams who don't expect there to be any changes is always unfortunate.
I realize this seems silly, but I worry about these cleanup type PR's much more than the bug fix ones. It is true I may have been at Microsoft too long ... because often the principle of least change is the one that guides our work.
There was a problem hiding this comment.
i splitted changes in multiple commits 😄 , feel free to use what you think is ok.
I understand the uex include is good for reference doc/examples etc, so np if used, but i dont see this repo on msdn
There was a problem hiding this comment.
The F# language service definitely isn't documented on MSDN, but it doesn't hurt to double check with the doc people.
There was a problem hiding this comment.
sure, as i said, easy to remove this commit from pr.
With pr is easier to revert than ask and wait for permission
Btw maybe if these file are needed, the files exists in an internal repo of doc team? Doc is a good candidate for open source contribution.
just curious of msdn page source like List.append with example etc 😄
There was a problem hiding this comment.
@KevinRansom nice, thx
|
Thanks for taking care of this stuff, I understand it's needed, and sort of a not fun task. I am very grateful that it is getting some attention. |
|
@enricosada, Thanks for signing the contribution license agreement so quickly! Actual humans will now validate the agreement and then evaluate the PR. |
|
Thank you for taking the time to take care of this work, we will take care of this at the start of the next cycle. Moving this to V.Next per: #371 |
- remove `#region`s - removed include of not existing doc in comments (noise) - remove redundant comments (`/// this is a constructor`) - remove commented code - remove an empty file closes #358 commit c34491923f46ecbf2984d58ba3bf4e3391205a6e Author: enricosada <enrico@sada.io> Date: Thu Apr 16 15:03:14 2015 +0200 removed comment commit 6daf02cf3d65c342f4aff8d4bebc1cc2fa0a3506 Author: enricosada <enrico@sada.io> Date: Fri Apr 10 14:56:39 2015 +0200 remove empty file commit 0e736d994beecbec9263808edb04f5170e99fbe0 Author: enricosada <enrico@sada.io> Date: Thu Apr 9 23:10:38 2015 +0200 remove commented code commit b4422b9eef39cccb10a60a0216f313915b10a5eb Author: enricosada <enrico@sada.io> Date: Fri Apr 10 11:26:29 2015 +0200 removed redundant comments commit f8a981dc1f88db773be00bfff7aa993424eab985 Author: enricosada <enrico@sada.io> Date: Thu Apr 9 23:19:34 2015 +0200 remove include external doc in comments commit f59c84cd386ed89e5b99f950e145d33f02913e78 Author: enricosada <enrico@sada.io> Date: Fri Apr 10 14:56:00 2015 +0200 remove #region
|
Applied to the |
This remove code regions.
there are lot of regions by access or type (like
#region fieldor#region ctor) with few code inside.The regions for implementation of interface are not really useful, visual studio helps
Regions also hide the code and problems, easier without
Others:
/// this is a constructor)