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

corrected/clarified the setLoopPoints() documentation #2083

Merged
merged 1 commit into from
Apr 28, 2022

Conversation

Coder-Rahul-Y
Copy link
Contributor

@Coder-Rahul-Y Coder-Rahul-Y commented Apr 26, 2022

The previous documentation talks about 'end points' but the current code does not take end point as an argument and hence does not allow specifying the end point of the loop. (Instead the functions allows specifying the beginning offset and the length of the loop.)

Thanks a lot for making a contribution to SFML! 🙂

Before you create the pull request, we ask you to check the follow boxes. (For small changes not everything needs to ticked, but the more the better!)

  • [discussed in official Discord] Has this change been discussed on the forum or in an issue before?
  • [yes] Does the code follow the SFML Code Style Guide?
  • Have you provided some example/test code for your changes?
  • If you have additional steps which need to be performed list them as tasks!

Description

Please describe your pull request.

This PR is related to the issue #

Tasks

  • Tested on Linux
  • Tested on Windows
  • Tested on macOS
  • Tested on iOS
  • Tested on Android

How to test this PR?

Describe how to best test these changes. Please provide a minimal, complete and verifiable example if possible, you can use the follow template as a start:

#include <SFML/Graphics.hpp>

int main()
{
    sf::RenderWindow window(sf::VideoMode(1280, 720), "Minimal, complete and verifiable example");
    window.setFramerateLimit(60);

    while (window.isOpen())
    {
        sf::Event event;
        while (window.pollEvent(event))
        {
            if (event.type == sf::Event::Closed)
                window.close();
        }

        window.clear();
        window.display();
    }
}

@codecov
Copy link

codecov bot commented Apr 26, 2022

Codecov Report

❗ No coverage uploaded for pull request base (2.6.x@b6ca47e). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head a00638d differs from pull request most recent head 86f1a84. Consider uploading reports for the commit 86f1a84 to get more accurate results

Impacted file tree graph

@@           Coverage Diff           @@
##             2.6.x   #2083   +/-   ##
=======================================
  Coverage         ?   8.92%           
=======================================
  Files            ?     185           
  Lines            ?   15874           
  Branches         ?    4190           
=======================================
  Hits             ?    1416           
  Misses           ?   14326           
  Partials         ?     132           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b6ca47e...86f1a84. Read the comment docs.

@Coder-Rahul-Y
Copy link
Contributor Author

I want to target the 2.6.x branch too. Should I rebase this pull req?

@ChrisThrasher
Copy link
Member

I want to target the 2.6.x branch too. Should I rebase this pull req?

PRs can only target a single branch. If you want to merge this into 2.6.x and master the you'll have to make 2 PRs, but don't do that until the first is merged.

@eXpl0it3r
Copy link
Member

Alternatively, you can rebase this PR onto 2.6.x and change the target to 2.6.x instead of master and eventually the commit will be backmerged to master

The previous documentation talks about 'end points' but the current code does not take end point as an argument and hence does not allow specifying the end point of the loop. (Instead the functions allows specifying the beginning offset and the length of the loop.)
@Coder-Rahul-Y
Copy link
Contributor Author

Successfully changed the base of this PR to 2.6.x branch. This PR is ready for review now.

@eXpl0it3r eXpl0it3r merged commit 33cb8f4 into SFML:2.6.x Apr 28, 2022
@eXpl0it3r
Copy link
Member

Thank you for making the documentation clearer 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants