Open kozross opened 3 years ago
Based on #3, these are some of the annotations we should add in my opinion:
@see
@deriving
@law
@method
@throws
@totality
@unsafe
unsafePerformIO
Any others?
Based on #3, these are some of the annotations we should add in my opinion:
@see, functioning as a 'See also' section, similar to the one in JavaDocs@deriving, as per #3.@lawfor type class laws@methodfor documenting individual methods of a type class@throwsfor indicating what exceptions people should expect to have to catch from this function@totalityto describe whether something is total or partial@unsafefor functions that should be used with care, likeunsafePerformIOAny others?