-
Notifications
You must be signed in to change notification settings - Fork 3.8k
[mdoc] Added -api-style parameter. #2333
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
Conversation
|
@jonpryor: ping for review, when you get a chance? :) |
I'm not fond of this idea, in large part because I have no idea what it means regarding backward compatibility. How do I know if I have a "classic" assembly? How do I know that I don't have one? My concern is that I and others have existing Makefiles which use Based on the patch itself, I think it might make more sense to use |
|
Well, all of this functionality, truth be told, was added to support a singular product, which is Xamarin's iOS assemblies ... so from a backwards compatibility perspective, there is only one "client" of this feature, and I've adjusted that makefile accordingly (that PR internally is waiting for this PR). Now, in the context of the feature itself, this is all predicated on the fact that a namespace prefix is being dropped ... so in the case of iOS, Right now, there is too much internal logic that depends on the I'm going to change it as you suggest, so that there's an |
|
@jonpryor ok, I've made some small changes so that instead of Additionally ... like you mention, this opens up future extensibility of this feature so that the api style value can be controlled from the command line :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style: This line should be indented an extra tab stop so that it doesn't look like if block contents
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jonpryor, ok, that was fair, I added the extra tab stop :)
|
LGTM, aside from the previously mentioned code formatting. |
You must now add the -api-style parameter when running mdoc update for a set of classic or unified assemblies. This was added in order to properly support types and members that exist only in one or the other set. Previously, there was an assumption that all types and members would be reflected in both classic and unified versions of an assembly.
[mdoc] Added -api-style parameter.
|
Thanks! |
You must now add the
-api-styleparameter when runningmdoc updatefor a set of classic/unified assemblies.This was added in order to properly support types and members that exist only in one or the other set.
Previously, there was an assumption that all types and members would be reflected in both classic and
unified versions of an assembly. This patch fixes that assumption so that members present only in one set of assemblies or the other are properly represented in the resulting XML.