Bug 57756 - ToolbarItem.Priority docs are worse than useless
Summary: ToolbarItem.Priority docs are worse than useless
Status: RESOLVED NOT_ON_ROADMAP
Alias: None
Product: Forms
Classification: Xamarin
Component: Forms ()
Version: 2.3.4
Hardware: PC Windows
: --- normal
Target Milestone: ---
Assignee: Bugzilla
URL:
Depends on:
Blocks:
 
Reported: 2017-06-26 11:00 UTC by Edward Brey
Modified: 2017-06-28 19:51 UTC (History)
1 user (show)

Tags:
Is this bug a regression?: ---
Last known good build:


Attachments
Screenshot (17.22 KB, image/png)
2017-06-26 11:00 UTC, Edward Brey
Details


Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on Developer Community or GitHub with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED NOT_ON_ROADMAP

Description Edward Brey 2017-06-26 11:00:04 UTC
Created attachment 23113 [details]
Screenshot

If I Go To Definition of ToolbarItem, I see a collapsed view of the class metadata (see screenshot). I wanted to know what Priority was for, so I expanded its outline group. To my dismay, I saw this:

		//
		// Summary:
		//     Gets or sets the priority of this Xamarin.Forms.ToolbarItem element.
		//
		// Remarks:
		//     To be added.

What new information did the comments provide? Absolutely nothing. At the very least, please strip out all meaningless boilerplate comments, so that the outline expansion button won't appear and waste our time. Or preferably, if the meaning isn't obvious from the name (as is the case with Priority), provide real comments that tell us things mean.
Comment 1 Jason Smith [MSFT] 2017-06-28 19:51:35 UTC
We have no plans at this time to remove redundant information from the docs that could be inferred from the name of the method because it was well named in the first place.