Skip to content

Useless information #762

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

Open
wahboh opened this issue Apr 30, 2018 — with docs.microsoft.com · 7 comments
Open

Useless information #762

wahboh opened this issue Apr 30, 2018 — with docs.microsoft.com · 7 comments
Labels
area-WPF Issues or PRs that relate to WPF or XAML. Pri2 Indicates issues/PRs that are medium priority unspecified/svc
Milestone

Comments

Copy link

wahboh commented Apr 30, 2018

Assume that I want to write a handler for this event. Where do I find the interface description?
The new documnetation is all to often totally useless lacking substantial information and examples.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@BillWagner
Copy link
Member

Removing the external label: This content should link to the System.Windows.DependencyPropertyChangedEventHandler type, which has all the information needed.

@svick
Copy link
Contributor

svick commented Jun 4, 2018

@BillWagner Shouldn't all pages for events link to their event handler type? I think that would be an "external" issue.

@BillWagner
Copy link
Member

@svick Yes, in general. Some use a type of EventHandler which has no arguments, so that's not super useful.

@dend What are your thoughts?

@wahboh
Copy link
Author

wahboh commented Jun 4, 2018

Dear All,
Please do not underestimate the power of examples. Many doc pages are just the spec, but I can vouch from loong experience that what most pro programmers really need, are small examples on howto use. Can oneliners, or very brief, but it says much more than just the spec.
Thanks!

@BillWagner
Copy link
Member

@wahboh I agree. Samples are great. What we need to do is make the samples easy to find, which means getting them on the right pages, and then linking to them from other relevant pages. Which do you think would be easier to find: the event, or the event handler type?

@dend
Copy link
Contributor

dend commented Jun 5, 2018

So to distill the problem, I think there are two asks:

  1. Linking to the base event handler (in the case above, System.Windows.DependencyPropertyChangedEventHandler) from the event page.
  2. Adding more examples for events.

For (1), am I interpreting the request correctly?

@BillWagner @wahboh

@wahboh
Copy link
Author

wahboh commented Jun 29, 2018

@BillWagner @dend
I have no strong opinion about Bill's #1 above. Generally when I as a developer search for info, I look at the immediate info. I do not very often trace back to some base class. On the other hand I can agree that info should be found where the function (etc) is declared, i e probably in the base class.
I leave it to you pros to put yourself in the situation of a confused (and maybe a bit lazy) developer who need instant (!) information (with an example) on the immediate (!) problem. How many steps will she/he trace the stack backwards?
May I humbly suggest a user friendly approach rather than a strict analytical?

@BillWagner BillWagner transferred this issue from dotnet/docs Nov 20, 2018
@dotnet-bot dotnet-bot added untriaged New issue has not been triaged by the area owner and removed rerun-labels labels Nov 20, 2018
@BillWagner BillWagner added Pri2 Indicates issues/PRs that are medium priority triaged and removed untriaged New issue has not been triaged by the area owner labels Nov 29, 2018
@BillWagner BillWagner added this to the Backlog milestone Nov 29, 2018
@eiriktsarpalis eiriktsarpalis added the area-WPF Issues or PRs that relate to WPF or XAML. label Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-WPF Issues or PRs that relate to WPF or XAML. Pri2 Indicates issues/PRs that are medium priority unspecified/svc
Projects
None yet
Development

No branches or pull requests

8 participants