Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from ? to * in docs and examples #109

Merged
merged 1 commit into from Sep 29, 2019

Conversation

milessabin
Copy link
Member

The plan for Dotty is to repurpose ? for wildcards instead of _. In #91 * was added to kind-projecter as alternative placeshold syntax to ?, and Dotty now also supports * as placeholder syntax for cross compilation via -Ykind-projector.

This PR updates the documentation and examples to use * rather than ? and adds a warning that the ? syntax will be deprecated in future.

The plan for Dotty is to repurpose `?` for wildcards instead of `_`.
In typelevel#91 `*` was added to kind-projecter as alternative placeshold syntax
to `?`, and Dotty now also supports `*` as placeholder syntax for cross
compilation via `-Ykind-projector`.

This PR updates the documentation and examples to use `*` rather than
`?` and adds a warning that the `?` syntax will be deprecated in future.
@SethTisue
Copy link
Member

the old syntax now appears in so many places that the change probably merits a mention (and a link to some kind of justification / further reading) in the readme

@milessabin
Copy link
Member Author

Copying what I wrote on #108 ...

There ought to be a more explanatory paragraph in the README, but I wasn't sure quite how to structure it: putting it right at the beginning is a bit disruptive for someone who just wants to learn about the plugin. OTOH there isn't really a particularly natural break to insert it later, and tacking it on right at the end makes it a bit hard to discover.

@@ -104,17 +104,17 @@ The simplest syntax to use is the inline syntax. This syntax resembles
Scala's use of underscores to define anonymous functions like `_ + _`.

Since underscore is used for existential types in Scala (and it is
probably too late to change this syntax), we use `?` for the same
purpose. We also use `+?` and `-?` to handle covariant and
probably too late to change this syntax), we use `*` for the same
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parenthetical is now incorrect, and should probably be replaced by a link to http://dotty.epfl.ch/docs/reference/changed-features/wildcards.html

@SethTisue
Copy link
Member

SethTisue commented Jul 3, 2019

putting it right at the beginning is a bit disruptive

I think early could be okay if it were very short, perhaps an in-line parenthetical:

(formerly ?, see LINK)

or a very short paragraph:

(Q: It's * now, not ?? A: Yes, see LINK)

README.md Show resolved Hide resolved
@smarter
Copy link
Contributor

smarter commented Sep 18, 2019

Ping, would be nice to see this merged.

larsrh added a commit that referenced this pull request Sep 29, 2019
@larsrh larsrh merged commit 9649049 into typelevel:master Sep 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants