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

Hide controller methods from documentation #356

Merged
merged 2 commits into from
May 4, 2015
Merged

Hide controller methods from documentation #356

merged 2 commits into from
May 4, 2015

Conversation

davidcollie
Copy link
Contributor

Reasons for feature and a description of the functionality described in issue #355

Example:

api :GET, '/users/see_another', 'Boring hidden method that we do not want clients to know about yet'
show false
see 'development#users#create'
see 'development#users#index', "very interesting method reference"
desc 'This method is boring, look at users#create.  It is hidden from documentation.'
def see_another
  render :text => 'This is very similar to create action'
end

@davidcollie
Copy link
Contributor Author

I had to merge in PR #350 for testing purposes.

I can refactor the DSL name from show to something else if there is a strong objection to that name.

@iNecas
Copy link
Member

iNecas commented May 4, 2015

It seems nobody objects on the name. Mergning now. Thanks @davidcollie

iNecas added a commit that referenced this pull request May 4, 2015
Hide controller methods from documentation
@iNecas iNecas merged commit f697ec2 into Apipie:master May 4, 2015
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

Successfully merging this pull request may close these issues.

3 participants