matbarofex / rRofex

R library to connect to Matba Rofex's Trading API. Functionality includes accessing account data and current holdings, retrieving investment quotes, placing and canceling orders, and getting reference data for instruments.
https://matbarofex.github.io/rRofex
Other
25 stars 14 forks source link

Problems with documentation references #6

Closed kenarab closed 5 years ago

kenarab commented 5 years ago

Describe the bug Bad references in documentation

To Reproduce Steps to reproduce the behavior:

rRofex::trading_login(username="xxx", password="xxx", env ="reMarkets")
Warning message:
In rRofex::trading_login(username = "xxx", password = "xxx",  :
  Something went wrong... =/
> rRofex::trading_instruments(request = "securities", sec_detailed = T)
Error in rRofex::trading_instruments(request = "securities", sec_detailed = T) : 
  You should first log in using primary_login()

Expected behavior

Screenshots

Desktop (please complete the following information):

gdpar commented 5 years ago

I've obtained message error using 'Enviroment' or 'Env' as parameter because I didn't have it declared previously in my workspace. Considering the example in the reference documentation I had to use the '<-' operator in the function call: rRofex::trading_login(username="xxx", password="xxx", Enviroment<- "reMarkets")

or just rRofex::trading_login(username="xxx", password="xxx", "reMarkets")

kenarab commented 5 years ago
rRofex::trading_login(username="xxx", password="xxx", Enviroment<- "reMarkets")

IS BAD! You are making an assignation to variable "Enviroment" in the function call.

rRofex::trading_login(username="xxx", password="xxx", env = "reMarkets")

Is the correct call. I made a PR with small changes regarding this issue

augustohassel commented 5 years ago

Tks @kenarab ! I've already accepted your pull request! If you find something else, just open an issue! @gdpar, Alejandro is right, I've made a mistake on the documentation!

kenarab commented 5 years ago

Gr8 to collaborate!

On Thu, Jun 27, 2019 at 6:44 PM Augusto Hassel notifications@github.com wrote:

Tks @kenarab https://github.com/kenarab ! I've already accepted your pull request! If you find something else, just open an issue! @gdpar https://github.com/gdpar, Alejandro is right, I've made a mistake on the documentation!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/gruporofex/rRofex/issues/6?email_source=notifications&email_token=AAWMBVQT4B6TP7TECVFRFG3P4UYDZA5CNFSM4H3WPXUKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODYYO3QY#issuecomment-506523075, or mute the thread https://github.com/notifications/unsubscribe-auth/AAWMBVSVHHRSETS6NQ4IC2TP4UYDZANCNFSM4H3WPXUA .

-- alejandro baranek @ken4rab https://twitter.com/ken4rab qbotics http://qbotics.tumblr.com/ | rpolyhedra https://qbotics.shinyapps.io/rpolyhedra-explorer/?_inputs_&polyhedron_color=%22%23FF0000FF%22&polyhedron_name=%22Triakis%20Tetrahedron%22&polyhedron_source=%22dmccooey%22&show_axes=false | surferinvaders http://surferinvaders.tumblr.com | algebraic-soundscapes http://imaginary.org/content/algebraic-soundscapes | surfer-shuffle http://imaginary.org/program/surfer-shuffle