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

Documentation not up to date? #12

Closed
teejays opened this issue May 13, 2018 · 2 comments
Closed

Documentation not up to date? #12

teejays opened this issue May 13, 2018 · 2 comments

Comments

@teejays
Copy link

teejays commented May 13, 2018

Hi - I like the idea behind the project and was trying to use it in one of my projects. It seems like the documentation needs updating:

  1. the package needs to be imported with an explicit name "go_up"
  2. No function .build() but there is Build()
@ufoscout
Copy link
Owner

Hi @teejays

Thanks, I checked the documentation and fixed all the ".build()" typos.

About your point number 1:

the package needs to be imported with an explicit name "go_up"

could you please be more specific? I don't get exactly what is the issue. The default package name is "go_up" so it shouldn't be required. Are you using version 0.5.0?

@teejays
Copy link
Author

teejays commented May 19, 2018

Thanks. Yes, the second point makes sense. I got a little confused as I follow the standards of the package name exactly matching the project folder name.

In the documentation, can you make sure that the sample code uses go_up.NewGoUp(..) vs. NewGoUp(...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants