search

IgniteUI / igniteui-angular

Ignite UI for Angular is a complete library of Angular-native, Material-based Angular UI components with the fastest grids and charts, Pivot Grid, Dock Manager, Hierarchical Grid, and more.
https://www.infragistics.com/products/ignite-ui-angular
Other
572 stars 161 forks source link

IgxDateRangePickerComponent API change not reflected on the documentation. #9904

Closed yuhongcheng2003 closed 3 years ago

yuhongcheng2003 commented 3 years ago

Description

There is an API change in 12.x in IgxDateRangePickerComponent not reflected on the documentation. Method selectRange no lnoger exist and is renamed to select.

Steps to reproduce

Compare version 11.x to 12.x

Result

Documentation discrepancy on https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/classes/igxdaterangepickercomponent.html

Expected result

Documentation should always reflect the actual API, Integrate this change to NG UPDATE for auto migration.

Attachments

Doc: https://www.infragistics.com/products/ignite-ui-angular/docs/typescript/latest/classes/igxdaterangepickercomponent.html Repo https://github.com/IgniteUI/igniteui-angular/blob/12.0.x/projects/igniteui-angular/src/lib/date-range-picker/date-range-picker.component.ts

zdrawku commented 3 years ago

Hey @yuhongcheng2003, thank you for the notice! There is actualy a problem with the content generation that is more relevant to the deploying of the content rather to the library configuration itself.

For the time being my suggestion is to specify the exact latest version through the API version dropdown, for example: https://www.infragistics.com/products/ignite-ui-angular/docs/12.0.9/typescript/

When the docs are not refering to the latest site content everything should be fine.

yuhongcheng2003 commented 3 years ago

Thanks @zdrawku. The specific version seems fixed this issue. May I suggest to add an auto redirect on the latest to a specific version if this is not going to be fixed in a short term. The reason being that, all of the links from your demos/tutorial is pointing the latest and it could be confusing for anyone that is not aware of this issue.

Also, it would be nice to automatically migrate this change for me when I'm doing ng update to avoid the manual work.

Lipata commented 3 years ago

Hi, @yuhongcheng2003. Thank you for catching that igxDateRangePicker migrations are having a problem. Here is the fix and it will be available on Monday with 12.0.10 patch.

zdrawku commented 3 years ago

Both ng update migration and API docs should be available now on the API docs site and with 12.0.10 version of the product.