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 improvements #139

Merged
merged 1 commit into from
Oct 19, 2018
Merged

Documentation improvements #139

merged 1 commit into from
Oct 19, 2018

Conversation

szemek
Copy link
Contributor

@szemek szemek commented Oct 19, 2018

When I run bundle exec rake documentation I got warnings

[warn]: @param tag has unknown parameter name: q
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: page
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: per_page
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: sort
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: fields
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: include_fields
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: include_totals
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: from
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: take
    in file `lib/auth0/api/v2/logs.rb' near line 24
[warn]: @param tag has unknown parameter name: id
    in file `lib/auth0/api/v2/logs.rb' near line 51
[warn]: @param tag has unknown parameter name: connection
    in file `lib/auth0/api/v2/users.rb' near line 48
[warn]: @param tag has unknown parameter name: per_page
    in file `lib/auth0/api/v2/users.rb' near line 166
[warn]: @param tag has unknown parameter name: page
    in file `lib/auth0/api/v2/users.rb' near line 166
[warn]: @param tag has unknown parameter name: include_totals
    in file `lib/auth0/api/v2/users.rb' near line 166
[warn]: @param tag has unknown parameter name: sort
    in file `lib/auth0/api/v2/users.rb' near line 166
[warn]: @param tag has unknown parameter name: client_id
    in file `lib/auth0/api/v2/client_grants.rb' near line 35
[warn]: @param tag has unknown parameter name: client_id
    in file `lib/auth0/api/v2/client_grants.rb' near line 45
[warn]: @param tag has unknown parameter name: fields
    in file `lib/auth0/api/v2/users_by_email.rb' near line 16
[warn]: @param tag has unknown parameter name: include_fields
    in file `lib/auth0/api/v2/users_by_email.rb' near line 16
[warn]: @param tag has unknown parameter name: name
    in file `lib/auth0/api/v2/resource_servers.rb' near line 33
[warn]: @param tag has unknown parameter name: signing_alg
    in file `lib/auth0/api/v2/resource_servers.rb' near line 33
[warn]: @param tag has unknown parameter name: signing_secret
    in file `lib/auth0/api/v2/resource_servers.rb' near line 33
[warn]: @param tag has unknown parameter name: token_lifetime
    in file `lib/auth0/api/v2/resource_servers.rb' near line 33
[warn]: @param tag has unknown parameter name: scopes
    in file `lib/auth0/api/v2/resource_servers.rb' near line 33
[warn]: @param tag has unknown parameter name: fields
    in file `lib/auth0/api/v2/device_credentials.rb' near line 18
[warn]: @param tag has unknown parameter name: include_fields
    in file `lib/auth0/api/v2/device_credentials.rb' near line 18
[warn]: @param tag has unknown parameter name: user_id
    in file `lib/auth0/api/v2/device_credentials.rb' near line 18
[warn]: @param tag has unknown parameter name: type
    in file `lib/auth0/api/v2/device_credentials.rb' near line 18
[warn]: In file `lib/auth0/api/authentication_endpoints.rb':7: Cannot resolve link to @domain from text:
	...{@domain}...
[warn]: In file `lib/auth0/api/authentication_endpoints.rb':7: Cannot resolve link to @domain from text:
	...{@domain}...
[warn]: In file `lib/auth0/api/authentication_endpoints.rb':13: Cannot resolve link to @domain from text:
	...{@domain}...
[warn]: In file `lib/auth0/api/authentication_endpoints.rb':13: Cannot resolve link to @domain from text:
	...{@domain}...

In most cases param was inside of options hash, so I changed structure a bit and put all those hash keys under unordered list.
For example, #users(options = {}) ⇒ json instead of:
image
looks like this:
image

Copy link
Contributor

@joshcanhelp joshcanhelp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@joshcanhelp joshcanhelp added this to the v4-Next milestone Oct 19, 2018
@joshcanhelp joshcanhelp merged commit f6bb5e1 into auth0:master Oct 19, 2018
@szemek szemek deleted the documentation-improvements branch October 20, 2018 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants