Fix warn messages in doc #1255

mlachkar · 2020-10-08T12:24:41Z

use the new api for SemanticTree
add @unchecked for non exhaustive pattern matching (in doc)

fixes #1190

bjaglin

Nice, fixes #1190 ?

mlachkar · 2020-10-08T13:37:53Z

yes, it will fix #1190

bjaglin

👍 what about using -Xfatal-warnings so that docs remain up to date as deprecations are added?

bjaglin · 2020-10-11T11:52:04Z

docs/developers/semantic-type.md

@@ -49,7 +49,7 @@ Use `MethodSignature.returnType` to get the types of vals.

 ```scala mdoc
 def getType(symbol: Symbol): SemanticType =
-  symbol.info.get.signature match {
+  (symbol.info.get.signature: @unchecked) match {


maybe it's clearer with a case _ ?

You mean adding a case _ ?
So the return type will be Option[A]..

That would make the doc harder to read indeed... Does removing the --unchecked from scalacOption for the doc project silence these exceptions? If not, there is scala/scala#8373 that could be used as well to avoid repeating this everywhere (which should be usable since the doc is built using 2.13?).

removing -unchecked doesn't silence these exceptions

mlachkar

I am not a big fun of -Xfatal-warnings on documentation. I hesitated between adding a @unchecked or finding the correct scalacOptions to remove warning on exhaustive pattern match. I found on google the @unchecked first

mlachkar · 2020-10-12T04:44:49Z

docs/developers/semantic-type.md

@@ -49,7 +49,7 @@ Use `MethodSignature.returnType` to get the types of vals.

 ```scala mdoc
 def getType(symbol: Symbol): SemanticType =
-  symbol.info.get.signature match {
+  (symbol.info.get.signature: @unchecked) match {


You mean adding a case _ ?
So the return type will be Option[A]..

bjaglin · 2020-10-12T06:40:51Z

I am not a big fun of -Xfatal-warnings on documentation

why?

mlachkar · 2020-10-12T08:10:28Z

I am not a big fun of -Xfatal-warnings on documentation

why?
I mean in documentation having non exhaustive pattern matching is ok, it makes the doc easier to read. I am not against -Xfatal-warnings in general, just for this case.
I agree it's nice to have it for depreciate api.
I am also worried about the confusion @unchecked brings.

…in documentation

mlachkar · 2020-10-12T11:09:05Z

I fixed last warning and I added xfatal-wanings , and also used -Wconf to silence pattern match errors.

mlachkar force-pushed the doc branch from 821161e to f39a8cf Compare October 8, 2020 12:32

bjaglin reviewed Oct 8, 2020

View reviewed changes

Fix warn messages in doc

3461fb5

mlachkar force-pushed the doc branch from f39a8cf to 3461fb5 Compare October 8, 2020 13:37

bjaglin reviewed Oct 11, 2020

View reviewed changes

mlachkar commented Oct 12, 2020

View reviewed changes

mlachkar added 2 commits October 12, 2020 12:09

use -Wconf to silence warnings about non-exhaustive pattern matching …

4f6ca02

…in documentation

add Xfatal-warnings to docs project

db53fa7

mlachkar force-pushed the doc branch from 4a81696 to db53fa7 Compare October 12, 2020 11:08

bjaglin approved these changes Oct 12, 2020

View reviewed changes

mlachkar merged commit 39d6cf6 into scalacenter:master Oct 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix warn messages in doc #1255

Fix warn messages in doc #1255

mlachkar commented Oct 8, 2020 •

edited

bjaglin left a comment

mlachkar commented Oct 8, 2020

bjaglin left a comment

bjaglin Oct 11, 2020

mlachkar Oct 12, 2020

bjaglin Oct 12, 2020

mlachkar Oct 12, 2020

mlachkar left a comment

mlachkar Oct 12, 2020

bjaglin commented Oct 12, 2020

mlachkar commented Oct 12, 2020 •

edited

mlachkar commented Oct 12, 2020

Fix warn messages in doc #1255

Fix warn messages in doc #1255

Conversation

mlachkar commented Oct 8, 2020 • edited

bjaglin left a comment

Choose a reason for hiding this comment

mlachkar commented Oct 8, 2020

bjaglin left a comment

Choose a reason for hiding this comment

bjaglin Oct 11, 2020

Choose a reason for hiding this comment

mlachkar Oct 12, 2020

Choose a reason for hiding this comment

bjaglin Oct 12, 2020

Choose a reason for hiding this comment

mlachkar Oct 12, 2020

Choose a reason for hiding this comment

mlachkar left a comment

Choose a reason for hiding this comment

mlachkar Oct 12, 2020

Choose a reason for hiding this comment

bjaglin commented Oct 12, 2020

mlachkar commented Oct 12, 2020 • edited

mlachkar commented Oct 12, 2020

mlachkar commented Oct 8, 2020 •

edited

mlachkar commented Oct 12, 2020 •

edited