docs(v3): usage of `loadFromSamples` is wrong

Open
#259 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp
Domain
documentation

Research direction

Start with the v3 audio example docs at the linked “Sound or music” section and compare its call with the linked sf::SoundBuffer::loadFromSamples documentation. Update the example to pass all five required arguments and explain the fifth argument there; done means the example compiles and the argument is documented.

Written by the indexing model from the issue text.

Description

sf::SoundBuffer::loadFromSamples usage in the v3 audio example docs is wrong:

Image

One must provide loadFromSamples with 5 arguments, the docs shows a call with 4 arguments, which does not compile due to 5th not having a default value.

Example error message upon removing the 5th argument:
error C2660: 'sf::SoundBuffer::loadFromSamples': function does not take 4 arguments

Explanation of this argument should also be expected to be here.

Thanks for the wonderful work!

Dominant language
PHP
Stars
32
Forks
49
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SFML/SFML-Website

All issues in SFML/SFML-Website

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.