Convert Library Evolution docs from ReST to Markdown. #369
Conversation
|
I'm a little worried about losing all the tables of contents. Some of these docs are quite big and it's unfortunate not to have them. On the other hand, having to specify them manually and keep them up to date would also be a loss. Maybe we can add the Kramdown placeholder, so that someone actually rendering the docs using Kramdown will get one. (Why Kramdown? Because the Swift website is using Jekyll, and we could conceiveably put the docs there.) |
| } else { | ||
| print("BOO!!") | ||
| } | ||
| } |
There was a problem hiding this comment.
What about:
```swift // Code here ```
In order to make it highlighted?
@jrose-apple presumably that would be just after the title? I'm also thinking that it wouldn't have its own heading since that would look strange on GitHub, but please let me know what you think. |
|
I think I've addressed all of the feedback so far. I'll check back later for anything further. |
| types. These are similar to the internal `effects` attribute we have for | ||
| functions, except that they can be enforced by the compiler. | ||
|
|
||
| - `trivial`: Promises that the type is trivial. Note that this is not a |
There was a problem hiding this comment.
Sorry, I just meant the attribute name didn't need to be linked. The word "trivial" in the first sentence should still be linked to #trivial.
There was a problem hiding this comment.
Updated in b849183d854540a046e8a0ab0b56fee0397ff3d9. Please let me know if that's still not right.
|
Thanks, this all looks good! Can you squash it down to a single commit for the merge? |
paulyoung
force-pushed
the
library-evolution-md
branch
from
b4ced9c to
5702493
Compare
|
Done! |
|
All right, that's two down. Thanks, Paul! |
Convert Library Evolution docs from ReST to Markdown.
Convert Library Evolution docs from ReST to Markdown.
Report crash messages on Windows to the CRT
Remove unnecessary xfail for Kickstarter
This is the same as #363 but against the correct branch.
cc @jrose-apple