You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Should teach versioning in C# through the use of the override and new keywords.
Tutorials should include one or more code examples, each example should also show expected output and should include an explanation of the code where it isn't obvious. Examples shouldn't be dependent on a specific IDE or target platform.
If so, let's learn from our experience with the XML doc article. Let's start with an outline, either as a comment on this issue, or as a PR with a Work in Progress (WIP) comment. Then, once we agree that the outline is good, then move forward. I want to avoid having you do as much re-work as the last time.
I'd like to see you approach this in terms of what happens for any of these kinds of methods when base classes change. For example:
What happens when a base class adds new overrides of a virtual method?
What happens when a base class adds new methods that conflict with a derived class's methods?
What happens when a base class changes the default value on any optional arguments?
Overall, readers should learn what changes they can make in version 2 (and later) that won't negatively impact the developers that created derived classes?
And, if a base class does make those kinds of breaking changes, how should the derived class author react?
Activity
tonerdo commentedon Sep 6, 2016
@BillWagner up for grabs?
BillWagner commentedon Sep 6, 2016
@tsolarin Sure. Do you want to work on this one?
If so, let's learn from our experience with the XML doc article. Let's start with an outline, either as a comment on this issue, or as a PR with a Work in Progress (WIP) comment. Then, once we agree that the outline is good, then move forward. I want to avoid having you do as much re-work as the last time.
tonerdo commentedon Sep 6, 2016
Sure @BillWagner, I'll get to creating a barebones first draft and post the link here once it's ready
tonerdo commentedon Sep 26, 2016
Sorry for the delay been a bit busy. Here's my outline https://github.com/tsolarin/core-docs/blob/versioning/docs/csharp/versioning.md. I couldn't find a pre-existing versioning page that contained documentation metadata.
Looking forward to your feedback
tonerdo commentedon Sep 27, 2016
/cc @BillWagner
BillWagner commentedon Sep 27, 2016
@tsolarin I will look at this today. (Got totally slammed yesterday).
Update: I've got a lot of deliverables this week related to Ignite. I'll review by Monday am.
BillWagner commentedon Oct 2, 2016
/cc @stevehoag (He wrote the original issue)
I'd like to see you approach this in terms of what happens for any of these kinds of methods when base classes change. For example:
Overall, readers should learn what changes they can make in version 2 (and later) that won't negatively impact the developers that created derived classes?
And, if a base class does make those kinds of breaking changes, how should the derived class author react?