Skip to content

Commit

Permalink
Remove scala doc (#363)
Browse files Browse the repository at this point in the history
* Add helpers for tuple

* Unformat productbuilder

* Remove unused atIndex

* Remove unused variables

* Fix tests

* Fix bugs related to option and other improvements

- Make listStrict the default behavior
- Make optional values for products with atleast one valid value
- Add documentation for auto derivation of custom types

* Fix formatting

* Handle parent optional key

* Add examples for custom derivations

* Add optional example

* Add optional examples

* Add more documentation

* Reformat code

* Fix test cases

* Reformat code in examples module

* Make listStrict behaviour specific to sources

* Add documentation

* Reformat test cases

* Make run all tests

* Change documentations

* Fix fmt of test

* Remove comments

* Fix compile issue for scala 2.11 and scala 2.12

* Fix microsite

* Fix documentation of automatic

* Fix docs

* Add docs

* Remove all scala

* Make docs cleaner

* Remove scala doc
  • Loading branch information
afsalthaj authored Jun 22, 2020
1 parent 6a8ad1c commit 2e685de
Showing 1 changed file with 0 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -142,28 +142,6 @@ trait DeriveConfigDescriptor { self =>
desc.optional

case class Descriptor[T](desc: ConfigDescriptor[T], isObject: Boolean = false) {

/**
* A set of helpers to do custom implicit derivations, that is
* a subset of functionalities provided for ConfigDescriptor.
*
* {{{
* implicit val awsRegionDesc: Descriptor[AmazonRegion] =
* Descriptor[String].xmap(Region.fromString, _.value)
* }}}
*
* Another example where only Left fails, but with a different error type.
* In this case, it's better to give proper descriptive error message.
* Example:
*
* {{{
* implicit val descriptorO: Descriptor[ZonedDateTime] =
* Descriptor[String].xmapEitherELeftPartial(
* x => Try (ZonedDateTime.parse(x)).toEither)(_.toString)(
* t => s"Cannot parse zoned date time. ${t.getMessage}"
* )
* }}}
*/
final def ??(description: String): Descriptor[T] =
describe(description)

Expand Down

0 comments on commit 2e685de

Please # to comment.