Skip to content

Commit 3adfea9

Browse files
committed
Change the docs
1 parent 82efa62 commit 3adfea9

File tree

2 files changed

+4
-11
lines changed

2 files changed

+4
-11
lines changed

docs/src/main/tut/index.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ Easy ! Use `safeStr"your log $a $b, $c"` instead of `s"your log $a $b, $c"` !
2727
Add this in your build.sbt
2828

2929
```scala
30-
libraryDependencies += "io.github.afsalthaj" %% "safe-string" % "1.2.9"
30+
libraryDependencies += "io.github.afsalthaj" %% "safe-string" % "1.3.0"
3131
```
3232

3333
Or, in ammonite;
3434

3535
```scala
36-
@ import $ivy.`io.github.afsalthaj::safe-string:1.2.9`
36+
@ import $ivy.`io.github.afsalthaj::safe-string:1.3.0`
3737
import $ivy.$
3838
```
3939

@@ -75,14 +75,7 @@ scala> safeStr"Doesn't work if there is a non-case class ${nonCaseClass.toString
7575
`safeStr""` is just like `s""` in scala, but it is type safe and _allows only_ types that has a safe instance.
7676

7777
But don't worry. If you have a case class, the macros in `Safe.scala` will automatically derive it's safe instance
78-
as far as all ofthe individual fields has `Safe` instance which is also defined already in the companion object of `Safe`.
79-
It works for any deep/nested level of case classes.
80-
81-
To sum up,
82-
83-
* Most of the types already has a Safe instance in companion object, hence `Int`, `Double` etc works straight away.
84-
* **case classes** will be converted to json-like string by inspecting all fields, be it deeply nested or not, at compile time.
85-
* `Secret` types will be hidden too. We will see more on these in the below links.
78+
as far as all the individual fields has `Safe` instance.
8679

8780
To understand more on the concepts and usages, please go through:
8881

project/DocSupport.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ object DocSupport {
2828
micrositeHighlightTheme := "atom-one-light",
2929
micrositeGithubRepo := "safe-string-interpolation",
3030
micrositeHomepage := "https://afsalthaj.github.io/safe-string-interpolation",
31-
micrositeBaseUrl := "iagcl/safe-string-interpolation",
31+
micrositeBaseUrl := "/safe-string-interpolation",
3232
micrositeGithubOwner := "afsalthaj",
3333
micrositeGithubRepo := "safe-string-interpolation",
3434
micrositeGitterChannelUrl := "safe-string-interpolation/community",

0 commit comments

Comments
 (0)