-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Symbols Glossary #1094
Closed
Closed
Symbols Glossary #1094
Changes from 8 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
f983600
Added symbols file
zainab-ali 7e001c8
Update symbols.md
zainab-ali 5b032c9
Update symbols.md
zainab-ali d62d636
Update symbols.md
zainab-ali a9994cb
Update symbols.md
zainab-ali 1a25cf3
Update symbols.md
zainab-ali 3eed7bf
Update symbols.md
zainab-ali 6b24def
Updating symbols
zainab-ali a8b2948
Changing layout
zainab-ali ad1e06d
Update symbols.md
zainab-ali 731d99d
Update symbols.md
zainab-ali 83642aa
Update symbols.md
zainab-ali 9c56add
Update symbols.md
zainab-ali 173120d
Update symbols.md
zainab-ali ffcb6db
Adding symbols
zainab-ali 2b78040
Adding more symbols
zainab-ali 959eadd
Adding more symbols
zainab-ali bb73dfe
Adding more symbols
zainab-ali aed6fb0
Merge remote-tracking branch 'upstream/master' into symbols_edit
zainab-ali 067a5ad
Update symbols.md
zainab-ali 96d7530
Adding Symbols chart
zainab-ali File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| | Symbol | Name | Typeclass | Import | Source | | ||
| | ------ | ---------------------- | ------------ | -------------------------- | ------------------------------------------------- | | ||
| | `<*>` | apply | `Apply` | TBA | core/src/main/scala/cats/Apply.scala | | ||
| | `|@|` | Cartesian builder | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | | ||
| | `*>` | right apply | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | | ||
| | `<*` | left apply | `Cartesian` | `cats.syntax.cartesian._` | core/src/main/scala/cats/Cartesian.scala | | ||
| | `===` | equals | `Eq` | `cats.syntax.eq._` | kernel/src/main/scala/cats/kernel/Eq.scala | | ||
| | `=!=` | not equals | `Eq` | `cats.syntax.eq._` | kernel/src/main/scala/cats/kernel/Eq.scala | | ||
| | `>>=` | flatMap | `FlatMap` | `cats.syntax.flatMap._` | core/src/main/scala/cats/FlatMap.scala | | ||
| | `|-|` | remove | `Group` | `cats.syntax.group._` | kernel/src/main/scala/cats/kernel/Group.scala | | ||
| | `>` | greater than | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| | ||
| | `>=` | greater than or equal | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| | ||
| | `<` | less than | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| | ||
| | `<=` | less than or equal | `PartialOrder` | `cats.syntax.partialOrder._` | kernel/src/main/scala/cats/kernel/PartialOrder.scala| | ||
| | `|+|` | plus | `Semigroup` | `cats.syntax.semigroup._` | kernel/src/main/scala/cats/kernel/Semigroup.scala | | ||
| | `<+>` | combine | `SemigroupK` | `cats.syntax.semigroupk._` | core/src/main/scala/cats/SemigroupK.scala | | ||
| | `~>` | natural transformation | `FunctionK` | `cats._` | core/src/main/scala/cats/arrow/FunctionK.scala | | ||
| | `⊥` | bottom | N/A | `cats._` | core/src/main/scala/cats/package.scala | | ||
| | `⊤` | top | N/A | `cats._` | core/src/main/scala/cats/package.scala | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe the source location for this should be the generated source file in
src_managed?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also think we could leave out the source location and do pretty well. I'd rather have a column that relates the syntax to the type class, if possible. E.g.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also have mixed feelings about the imports. It is nice to let people know where things are, but I worry that this is encouraging people to use the piecemeal imports, which are often a source of frustration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@non I agree with getting rid of the imports and having an example usage.
I'm undecided about what to do with the source file. People often want to know where a symbol is defined, but because most of them use simulacrum or macro expansions, there isn't a straightforward location. @DavidGregory084 wouldn't references to
src_managedconfuse people, as it isn't present on GitHub? Perhaps a link to the source file or syntax file would be better.I'm leaning towards:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I'm fine with links to the files. In the case of generated sources, maybe we should italicize the name instead of linkifying it, and then putting a note at the bottom that italicized names are from generated source?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to link to the scaladoc instead of the source? That should have the generated methods, and it contains a link to the source in the non-generated case.