Closed RahulRaj97 closed 6 months ago
Enhancement of realSwipe function
The realSwipe
function, which simulates touch swipe events on the screen, has been improved. It now includes a new element termed as direction
that can be utilized to specify the course of the swipe (to the left, right, top, or bottom). This change allows users to have more control on the direction of the swipe they want to simulate.
Documentation Update for realSwipe
We have updated the details for realSwipe
to incorporate the latest changes. A new link directing to the in-depth cyrealswipe
documentation has been added. This will serve as an informative guide, offering a deeper understanding of the function, its parameters and usage.
:tada: This PR is included in version 1.13.0 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
Summary
This PR focuses on updating the comments related to the
realSwipe
function in the TypeScript type definitions. Specifically, it corrects the documentation link and enhances the clarity of existing commentsChanges
@see
URL for therealSwipe
function to accurately direct users to the correct section of the GitHub README, ensuring developers have access to relevant and detailed usage instructions.realSwipe
function.Motivation
The primary goal of these updates is to make the documentation more user-friendly and accurate, thereby enhancing the developer experience. Clear documentation supports developers in utilizing the
realSwipe
function more effectively, fostering a more intuitive and productive development process.Impact
These documentation and comment enhancements do not introduce changes to the functionality or API of the
cypress-real-events
library. They are focused solely on improving the quality of information provided in the codebase, making it easier for developers to understand and implement features correctly.Thank you for considering this contribution. I believe these documentation improvements will greatly benefit the
cypress-real-events
community by providing clearer guidance and support. I am open to any feedback and further discussion on these changes.