Skip to content

Removing "see remarks" language #2032

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

Merged
merged 5 commits into from
May 8, 2017
Merged

Removing "see remarks" language #2032

merged 5 commits into from
May 8, 2017

Conversation

guardrex
Copy link
Contributor

Fixes #2031

Per #2003 (comment): Language for "see remarks" in various forms are in dozens of files for <summary>, <param>, and <returns>. This PR removes that language.

@rpetrusha @mairaw Do we also need to remove this language from <value> and/or <exception> tags?

Update

Update

Update
@guardrex guardrex added the WIP label Apr 26, 2017
@guardrex guardrex self-assigned this Apr 26, 2017
@guardrex guardrex changed the title [WIP] Removing "see remarks" language Removing "see remarks" language Apr 27, 2017
@guardrex guardrex removed the WIP label Apr 27, 2017
@mairaw
Copy link
Contributor

mairaw commented Apr 27, 2017

I like this change. @rpetrusha what do you think? We could check if we have that in value or exception @guardrex, if Ron agrees.

@guardrex
Copy link
Contributor Author

Yes, there are uses of "see remarks" language in both <value> and <exception> tags. I don't have an exact count, but IIRC there are at least a few dozen cases.

@rpetrusha
Copy link
Contributor

@mairaw, @guardrex, yes, I like the change as well. I think it's worthwhile removing it from the other tags.

@guardrex
Copy link
Contributor Author

@mairaw @rpetrusha Last commit removes "see remarks" lingo from <value> and <exceptions> tags. I also caught a handful more to address with a "see the remarks" search. This round should get most instances covered. The ones that remain are in the Remarks sections themselves (e.g., "... see the Remarks of {some other API} ...").

It's ready for another look. 👀

@rpetrusha
Copy link
Contributor

@guardrex, is this ready to merge? If sop, there are two merge conflicts that have to be resolved.

@guardrex
Copy link
Contributor Author

guardrex commented May 4, 2017

@rpetrusha Sure .... I'll square those away right now.

@rpetrusha
Copy link
Contributor

Unfortunately, @guardrex, there are additional merge conflicts.

Copy link
Contributor

@rpetrusha rpetrusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. You can merge it when you want, @guardrex.

@guardrex guardrex merged commit ea2e372 into dotnet:master May 8, 2017
@guardrex guardrex deleted the guardrex/remove-see-remarks branch May 8, 2017 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants