Skip to content

Commit 6496692

Browse files
committed
More explicit documentation
1 parent ab2541a commit 6496692

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

library/src-3.x/scala/quoted/Expr.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ package quoted {
2121

2222
implicit class ExprOps[T](expr: Expr[T]) {
2323

24-
/** Show a source code like representation of this expression */
24+
/** Show a source code like representation of this expression without syntax highlight */
2525
def show(implicit qctx: QuoteContext): String = qctx.show(expr, SyntaxHighlight.plain)
2626

2727
/** Show a source code like representation of this expression */

library/src-3.x/scala/quoted/Type.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ package quoted {
1313

1414
implicit class TypeOps[T](tpe: Type[T]) {
1515

16-
/** Show a source code like representation of this type */
16+
/** Show a source code like representation of this type without syntax highlight */
1717
def show(implicit qctx: QuoteContext): String = qctx.show(tpe, SyntaxHighlight.plain)
1818

1919
/** Show a source code like representation of this type */

library/src-3.x/scala/quoted/package.scala

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ package object quoted {
1313
* ```
1414
* where `expr: Expr[T]`
1515
*
16-
* This method shoul not be called in a context where there is already has a QuoteContext.
16+
* This method should not be called in a context where there is already has a `QuoteContext`
17+
* such as within a `run` or a `withQuoteContext`.
1718
*
1819
* May throw a FreeVariableError on expressions that came from a macro.
1920
*/
@@ -30,7 +31,8 @@ package object quoted {
3031
* ```
3132
* where `thunk: T`
3233
*
33-
* This method shoul not be called in a context where there is already has a QuoteContext.
34+
* This method should not be called in a context where there is already has a `QuoteContext`
35+
* such as within a `run` or a `withQuoteContext`.
3436
*/
3537
def withQuoteContext[T](thunk: given QuoteContext => T) given (toolbox: Toolbox): T = {
3638
var result: T = NoResult.asInstanceOf[T]

0 commit comments

Comments
 (0)