search

MarketSquare / robotframework-angularjs

An AngularJS and Angular extension to Robotframework's SeleniumLibrary
Apache License 2.0
34 stars 20 forks source link

Add keyword documentation for Set Ignore Implicit Angular Wait keyword #23

Closed aaltat closed 5 years ago

aaltat commented 5 years ago

Set Ignore Implicit Angular Wait keyword is missing keyword documentation and therefore it's users hard to understand what the keyword actually does. I also agree that name is not good and could be changed, but that is covered in #11

emanlove commented 5 years ago

I have updated the documentation in a couple places. The keyword documentation has been updated with documentation on each keyword and better formatting in the introductory Importing Library section.

I have also updated the project README.rst also on the topic of Importing the library.

@aaltat if you get a chance go ahead an take a look to see if this is clearer. I will also reach out on Slack for reviews from people using the library.

aaltat commented 5 years ago

There is: $timeouts nor $http those extra $ sings in the text (in several places.) Are there on purpose? Other than that, I am pretty happy.

emanlove commented 5 years ago

Yes, that is Angular syntax; not to confuse it with Robot Framework syntax. I had to re-read that and I think I could leave those out of the keyword document while giving a better understanding elsewhere that goes into some depth.

emanlove commented 5 years ago

Keyword documentation has been added to the project and published on the Github Project pages. This has been fixed in release 0.0.10. The last issue of the confusing syntax of the dollar sign used by both JavaScript and robot Framework has been removed and should be released in 0.0.11. As such I am closing this issue.