search

HealthCatalyst / Fabric.Cashmere

Health Catalyst’s comprehensive design system.
http://cashmere.healthcatalyst.net
Apache License 2.0
66 stars 76 forks source link

Documentation of Datepicker date implementation is unclear #884

Closed njwhc closed 4 years ago

njwhc commented 5 years ago

image

A few thoughts for consideration on the above documentation...

  1. Are additional pre-made modules supposed to be listed after HcNativeDateModule?
  2. Should HcNativeDateModule be described as imported from @healthcatalyst/cashmere instead of @angular/material?
  3. If the use of MomentDateAdapter is so highly encouraged, why are there no examples of it's usage? Few people read documentation. Fewer read it thoroughly. I have to assume fewer still are going to read the documentation so thoroughly to see this note and then adapt every example in the rest of the documentation to accommodate this guidance.

I hope you'll forgive me for being nitpicky and griping about seemingly minor things here. However, little stumbling blocks like these make me want to just walk away from Cashmere. After all, if a library isn't easy to use or its documentation is unclear, why should I bother with it?

andrew-frueh commented 4 years ago

@njwhc thanks for calling this out a while back, somehow this got lost in the while but just recently was brought back to our attention. I have a PR (#1199) currently in to clean up those docs, which admittedly were pretty rough. If you have a second to look over the changes - and have any additional recommendations, I'd very much appreciate the input. Thanks!

benjanderson commented 4 years ago

:tada: This issue has been resolved in version 6.7.4 :tada:

The release is available on:

Your semantic-release bot :package::rocket: