Skip to content
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

SR.Designer.cs is public API #1413

Closed
danmoseley opened this issue Jul 17, 2019 · 6 comments · Fixed by #1420
Closed

SR.Designer.cs is public API #1413

danmoseley opened this issue Jul 17, 2019 · 6 comments · Fixed by #1420
Assignees
Labels
🪲 bug Product bug (most likely)
Milestone

Comments

@danmoseley
Copy link
Member

src\System.Windows.Forms.Design\src\Resources\SR.Designer.cs contains the strings for Winforms implementation, but it is currently a public class which means we would be shipping it as public API and need to document it, not break it, etc.

It should be internal like similar classes in CoreFX (although in CoreFX it's generated in the build)

namespace System.Windows.Forms.Design.Resources {
    using System;
...
    public class SR {
@danmoseley
Copy link
Member Author

This is showing up as "must be documented" in our tooling which is why I noticed it

@merriemcgaw
Copy link
Member

Thanks @danmosemsft . I'll have @RussKie take a look. That spreadsheet scared me!

@merriemcgaw merriemcgaw added the 📚 documentation Documentation bug or improvement label Jul 17, 2019
@merriemcgaw merriemcgaw added this to the 3.0.0-Preview9 milestone Jul 17, 2019
@weltkante
Copy link
Contributor

@merriemcgaw I don't think that SR should be documented, it should be made internal like @danmosemsft suggested. All the SR classes are internal in Desktop Framework too, I don't see why they should start to be public.

RussKie added a commit to RussKie/winforms that referenced this issue Jul 18, 2019
@RussKie
Copy link
Member

RussKie commented Jul 18, 2019

@weltkante I think you may have misread Merrie's response.
We're turning it internal like everything else.

@weltkante
Copy link
Contributor

I was referring to the 'documentation' tag.

@RussKie RussKie added 🪲 bug Product bug (most likely) and removed 📚 documentation Documentation bug or improvement labels Jul 18, 2019
danmoseley pushed a commit that referenced this issue Jul 18, 2019
@danmoseley
Copy link
Member Author

thanks @RussKie

cc @carlossanlop

@dotnet dotnet locked as resolved and limited conversation to collaborators Feb 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🪲 bug Product bug (most likely)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants