dotnet / dotnet/dotnet-api-docs

Should mention differentiation between property schema changes and item data changes

Open
#1,908 0 comments 0 reactions 0 assignees View on GitHub
area-System.ComponentModel dotnet-api/prod Pri2 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

The constructor with a propertychanged mentions that it should only be used for object schema changes and with adequate `ListChangedType` value.

This is in contrast to item changes, which specify item indices and different `ListChangedType` values.

The remarks section on this type, `ListChangedEventArgs`, should mention and describe this differentiation.

Furthermore, it is unclear how a combination of the two should be handled. The `ListChangedType` can not be combined, but constructors with both types of parameters imply this is somehow possible and intended, but they do not document how it's supposed to work/be handled.

---
#### Document Details

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

* ID: 97c8c9f6-72f6-2fb9-feed-d9a0bfb6348f
* Version Independent ID: 72c6439d-375b-e584-fd70-593411554e41
* Content: [ListChangedEventArgs Class (System.ComponentModel)](https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.listchangedeventargs?view=netframework-4.7.2)
* Content Source: [xml/System.ComponentModel/ListChangedEventArgs.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ComponentModel/ListChangedEventArgs.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Contributor guide

Open the contributing guide

Research direction

Start with xml/System.ComponentModel/ListChangedEventArgs.xml and its constructors and remarks, then review the referenced ListChangedType documentation to establish the distinction between property-schema and item-data changes. Done means the remarks clearly explain both cases and how constructor arguments should be handled together.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.