Skip to content

Add documentation for intrinsic types #11674

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

Merged
merged 2 commits into from
Mar 18, 2021

Conversation

BarkingBad
Copy link
Contributor

No description provided.

@BarkingBad BarkingBad linked an issue Mar 9, 2021 that may be closed by this pull request
@BarkingBad BarkingBad force-pushed the scaladoc/intrinsic-definitions branch from 8b3206a to 190680c Compare March 11, 2021 12:50
@BarkingBad BarkingBad marked this pull request as ready for review March 11, 2021 12:50
@BarkingBad BarkingBad force-pushed the scaladoc/intrinsic-definitions branch 2 times, most recently from 302f346 to 91a2c1b Compare March 11, 2021 13:52
@BarkingBad BarkingBad force-pushed the scaladoc/intrinsic-definitions branch 3 times, most recently from ac8db0e to 00b20e8 Compare March 16, 2021 11:42
@BarkingBad
Copy link
Contributor Author

@smarter could you take a look is it ok? There is some documentation missing or deprecated since I copied it mostly from scala2 sources. Could you update the docs, as you are more profficient with these intrinsic types. You can commit directly onto my branch or create a separate PR. The only thing left to discuss is the syntax. The classes are from scala package which is mainly from stdlib which keeps wikisyntax. As I mentioned here we could specify which packages are in wikisyntax, but it would enforce us to keep these comments in wikisyntax as well because we share package name

Copy link
Member

@smarter smarter left a comment

Choose a reason for hiding this comment

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

As I mentioned here we could specify which packages are in wikisyntax, but it would enforce us to keep these comments in wikisyntax as well because we share package name

I don't have a particular preference here, but it really seems like supporting the {{{ syntax in the markdown syntax as I suggested in #11728 would be the simplest solution.

@BarkingBad BarkingBad force-pushed the scaladoc/intrinsic-definitions branch from fa6fba6 to a591808 Compare March 18, 2021 10:54
@BarkingBad BarkingBad enabled auto-merge March 18, 2021 12:18
@BarkingBad BarkingBad merged commit 041c7b2 into scala:master Mar 18, 2021
@Kordyjan Kordyjan added this to the 3.0.0 milestone Aug 2, 2023
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.

How to document the API of compiler intrinsic definitions
3 participants