Proc macro documentation #1585
Merged
Proc macro documentation #1585
Conversation
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
kngwyu
approved these changes
Apr 30, 2021
|
I figured out that docs for #pyclass and #pymethods don't get rendered if the |
davidhewitt
approved these changes
Apr 30, 2021
| /// | `weakref` | Allows this class to be [weakly referenceable][6]. | | ||
| /// | `extends = BaseType` | Use a custom baseclass. Defaults to [`PyAny`][4] | | ||
| /// | `subclass` | Allows Python classes to inherit from this class. | | ||
| /// | `unsendable`<!-- hack to stop the column from wrapping -->                                 | Required if your struct is not [`Send`][3]. Rather than using `unsendable`, consider implementing your struct in a threadsafe way by e.g. substituting [`Rc`][8] with [`Arc`][9]. By using `unsendable`, your class will panic when accessed by another thread.| |
There was a problem hiding this comment.
Can you explain how this hack works? 🧠
There was a problem hiding this comment.
They're whitespaces that do not permit wrapping.
If something tries minimizing the table column, "ham spam eggs" can wrap around their spaces, but "ham spam eggs" (ham spam eggs) will not.
There was a problem hiding this comment.
Ah, understood.
I think it's slightly more intuitive (although admittedly more ugly) to do something like
<span style="white-space: pre">`name = "python_name"`</span>
on the rows that we don't want to wrap, but I'll do that in a separate PR.
|
👍 thanks again for this, it's brilliant. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds documentation for the proc macros.
It's mostly meant as a quick reference, as well as a future place to add doc aliases (they are not very discoverable right now).
Rendered