Repository navigation
[Tracking] Code Spell-Checking Sprint #11984
Description
Activity
- changed the title
[-][Tracking] Code Spelling Sprint[/-][+][Tracking] Code Spell-Checking Sprint[/+]on Aug 25, 2024 I have done this to all the VB code except possibly the 2 spaces after periods and 100% sentences with period in XML comments. The biggest offender is the resource and language files which I am not comfortable changing.
Also missing "see" attribute in XML Comments (how many and when).
What about changing attr to attribute in local names and other misspellings in local variables? VS considers anything 4 characters or longer misspelled if it's not in the dictionary. For words with special meaning/casing/spelling is there a way in a repo to add to spell checker?
I will take on finishing the VB code if no one else wants to when exact scope is clear.
Reacted by Merrie McGaw@merriemcgaw how do I volunteer? I would like to try 1, There are two things that are easy to do, change local variable like attr to attribute (154 occurrences) it would include typeattr to typeAttribute and changing behaviour in behavior (29 occurrences) in comments. Also changing period with 2 spaces to period and 1 space.
Another issue causing a lot suggestions is below, I have no idea how to fix, should I just open a new issue?
Severity Code Description Project File Line Suppression State Details Message (active) IDE0130 Namespace "System.Windows.Forms" does not match folder structure, expected "System.Windows.Forms.System.Windows.Forms.Accessibility" System.Windows.Forms C:\Repos\Winforms\src\System.Windows.Forms\src\System\Windows\Forms\Accessibility\AccessibleRoleControlTypeMap.cs 6@paul1956 please go ahead and open a separate issue for the message above.
And I think you just volunteered 😉
@merriemcgaw i will open the separate issue a namespace warning but not volunteering as its a C# issue and solving it is way beyond my C# skills.
I will open 2 separate issues (if necessary) on attrib and 2 spaces after period and volunteer for those. Also the biggest use of 2 periods after space is resource strings, I assume you don’t want me to touch those.
Where does one open issues about the Repo, none of the public issues seem to fit?
Reacted by Merrie McGaw@merriemcgaw C# has quoted strings with 2 periods after space. I think that is a separate issue that need to be opened. Also, XML Summy comments that are extremely long and don't wrap at column 120.
@paul1956 I think you're right. Let's open a tracking issue on the content of quoted strings because I think that will take a bit more to do just right.
4 remaining items
I think your recommendation makes the most sense here. Let's do it.
@merriemcgaw2 reviewers (@Epica3055 and @lonitra ) suggested
I am fine with any decision; I will go back at the end and do 1 PR to fix them all to whatever you want.
@paul1956 - would you be interested to do a pass over the comments to ensure XML tags are used where needed https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags
@Tanya-Solyanik yes but I need more information, on what you are looking for. Lists for example might be supported but they are really hard for a human to read. Adding "See" would be interesting but there is little guidance for how often it should be used (first occurrence only, every occurrence).
@Tanya-Solyanik I realized I spent so much time on shorting C# lines, my Regex missed VB. I will do that later to avoid merge issues.
- added a commit that references this issue
on Sep 16, 2024 - added a commit that references this issue
on Sep 18, 2024 @Tanya-Solyanik there are still many spelling issues. I got many of the ones in comments but not the ones involving private C# variables.
Would you please assign this issue to me and my project partner, Phil3579.
Would you please assign this issue to me and my project partner, Phil3579.
Please feel free to take it
Hello, I would also like to be assigned this issue.
This is an approach suggestion for now, please feel free to comment.
Comments and variables in the source code still contain a LOT of typos or weird "spelling variations".
I would suggest, we create a list of areas (doing it all at the same time is WAY too invasive of course) for tracking, and then put the sub issues derived from that out there up-for-grabs, after we've defined, how we want to tackle this. Here is a rule list as a first suggestion:
camelcAsenAming(camelCaseNaming), but do not introduce camel case naming, unless you can answer "What would @JeremyKuhne or @lonitra do" confidently: The reason is, that we have a lot of Win32 API calls in the repo, and those variables have a naming standard which consist of a lot weird abbreviations and in addition is often just not camelCase, and not even camelCaseIsh.protected,internal(Friend),virtual(Overridable) let alonepublic. If there is an obvious typo in such a member, please create a new issue so we can discuss, if we want to touch it (sometimes even changing an Internal member can be a breaking change, since ... you know ... Reflection...).@Olina-Zhang, once we finalize this item and know what we want to do, we should take it over to the Designer repo, and - as suggestion - do the same?