Skip to content
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

Update Tutorials for v3 API #193

Closed
29 tasks done
ChrisThrasher opened this issue Oct 5, 2024 · 0 comments
Closed
29 tasks done

Update Tutorials for v3 API #193

ChrisThrasher opened this issue Oct 5, 2024 · 0 comments

Comments

@ChrisThrasher
Copy link
Member

ChrisThrasher commented Oct 5, 2024

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

  • index.md (No changes required)

Getting Started #198

  • getting-started/code-blocks.md
  • getting-started/linux.md
  • getting-started/macos.md
  • getting-started/compile-with-cmake.md
  • getting-started/visual-studio.md
  • getting-started/cmake.md

System

Window

Graphics

Network

Audio

@github-project-automation github-project-automation bot moved this to Planned in SFML 3.0.0 Oct 5, 2024
@ChrisThrasher ChrisThrasher changed the title Update C++ code examples for v3 API Update Tutorials for v3 API Oct 19, 2024
This was referenced Oct 29, 2024
@github-project-automation github-project-automation bot moved this from Planned to Done in SFML 3.0.0 Nov 5, 2024
@eXpl0it3r eXpl0it3r removed this from SFML 3.0.0 Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants