Skip to content
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.

Sign up for GitHub

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

Jump to bottom

column.pin and column.unpin API descriptions need improvement #3660

Closed
mpavlinov opened this issue Jan 18, 2019 · 0 comments · Fixed by #3664
Closed

column.pin and column.unpin API descriptions need improvement #3660

mpavlinov opened this issue Jan 18, 2019 · 0 comments · Fixed by #3664
Assignees
@mpavlinov
Labels
📖 documentation grid: column-pinning grid: general ✅ status: resolved Applies to issues that have pending PRs resolving them, or PRs that have already merged.

Comments

@mpavlinov
Copy link
Contributor

Description

column.pin and column.unpin APIs do not describe the return value and the reasons to return false.

  • igniteui-angular version: 6.2.3
  • browser: *

Steps to reproduce

  1. Goto column.pin and [column.unpin]
  2. Goto column.unpin
  3. Observe the descriptions

Result

There is no description that the APIs can return false.

Expected result

The descriptions should explain in details when the API can return false and why.
@mpavlinov mpavlinov self-assigned this Jan 18, 2019
mpavlinov added a commit that referenced this issue Jan 18, 2019
@mpavlinov
fix(docs): Adding description for column.pin and column.unpin APIs #3660
f12ee6c
mpavlinov added a commit that referenced this issue Jan 18, 2019
@mpavlinov
fix(docs): Adding description for column.pin and column.unpin APIs #3660
61e3ace
@mpavlinov mpavlinov mentioned this issue Jan 18, 2019
Merged
14 tasks
mpavlinov added a commit that referenced this issue Jan 18, 2019
@mpavlinov
fix(docs): Adding description for column.pin and column.unpin APIs #3660
52961e3
@mpavlinov mpavlinov mentioned this issue Jan 18, 2019
Merged
14 tasks
@mpavlinov mpavlinov added the ✅ status: resolved Applies to issues that have pending PRs resolving them, or PRs that have already merged. label Jan 18, 2019
kdinev added a commit that referenced this issue Jan 18, 2019
@kdinev
Merge pull request #3662 from IgniteUI/mpavlov/pinning-docs
4a046ec 
fix(docs): Adding description for column.pin and column.unpin APIs #3660
mpavlinov added a commit that referenced this issue Jan 23, 2019
@mpavlinov
fix(docs): Adding description for column.pin and column.unpin APIs #3660
1ec9d5c 
 (#3663)
mpavlinov added a commit that referenced this issue Jan 23, 2019
@mpavlinov
fix(docs): Adding description for column.pin and column.unpin APIs #3660
f8e2fbb 
 (#3664)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mpavlinov mpavlinov

Labels
📖 documentation grid: column-pinning grid: general ✅ status: resolved Applies to issues that have pending PRs resolving them, or PRs that have already merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(docs): Adding description for column.pin and column.unpin APIs #3660 IgniteUI/igniteui-angular
1 participant
@mpavlinov