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

Problems with documentation references #6

Closed
kenarab opened this issue Jun 26, 2019 · 4 comments
Closed

Problems with documentation references #6

kenarab opened this issue Jun 26, 2019 · 4 comments
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@kenarab
Copy link
Contributor

kenarab commented Jun 26, 2019

Describe the bug
Bad references in documentation

  • Formal parameter for method trading_login environment included in README.md is env
  • A command call references to primary_login which does not exists (the call should be trading_login?)

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):

  • macOS
  • R 6.0
@kenarab kenarab added the bug Something isn't working label Jun 26, 2019
@kenarab kenarab changed the title Login is not working and problems with documentation references Problems with documentation references Jun 26, 2019
@gdpar
Copy link

gdpar commented Jun 27, 2019

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
Copy link
Contributor Author

kenarab commented Jun 27, 2019

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
Copy link
Member

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!

@augustohassel augustohassel added the good first issue Good for newcomers label Jun 27, 2019
@kenarab
Copy link
Contributor Author

kenarab commented Jun 28, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants