You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need to audit the new files added to pages/tutorials/3.0 in #191 for consistency with the current state of the library. This includes updating all code examples and all text discussing how these APIs work. For example a sentence that says "this function returns -1 on error" needs to be changed to reflect that the API now returns std::nullopt upon error. The latter is probably going to be the more tedious thing to update. In some places we will need to add new text to discuss new features.
This issue will track the state of each file. I ask that anyone working on this fix one or more files in their entirety so that no file is left in a partially edited state. A given PR may update multiple files. Just be sure to link to that PR in this issue. Please speak up and claim a given file you wish to update so that no two people rewrite the same file.
If we want to add new documentation files or remove some then that ought to be discussed as well. If a file is going to be removed it would be nice to remove it before we do the work to update it.
Style Changes
I wish to make one style change while we're touching these files. migration.md was written such that each sentence is its own line of Markdown code. This is contrast to the current state of these Markdown files where an entire paragraph of text is one line of code. This is cumbersome because changing a single character results in a diff where the entire paragraph is marked as changed. One sentence per line is a simple fix to that problem.
Description
We need to audit the new files added to pages/tutorials/3.0 in #191 for consistency with the current state of the library. This includes updating all code examples and all text discussing how these APIs work. For example a sentence that says "this function returns -1 on error" needs to be changed to reflect that the API now returns
std::nullopt
upon error. The latter is probably going to be the more tedious thing to update. In some places we will need to add new text to discuss new features.This issue will track the state of each file. I ask that anyone working on this fix one or more files in their entirety so that no file is left in a partially edited state. A given PR may update multiple files. Just be sure to link to that PR in this issue. Please speak up and claim a given file you wish to update so that no two people rewrite the same file.
If we want to add new documentation files or remove some then that ought to be discussed as well. If a file is going to be removed it would be nice to remove it before we do the work to update it.
Style Changes
I wish to make one style change while we're touching these files. migration.md was written such that each sentence is its own line of Markdown code. This is contrast to the current state of these Markdown files where an entire paragraph of text is one line of code. This is cumbersome because changing a single character results in a diff where the entire paragraph is marked as changed. One sentence per line is a simple fix to that problem.
Files
Getting Started #198
System
Window
Graphics
Network
Audio
The text was updated successfully, but these errors were encountered: