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

Decorators look messy in documentation #5

Open
saalaa opened this issue Aug 29, 2018 · 1 comment
Open

Decorators look messy in documentation #5

saalaa opened this issue Aug 29, 2018 · 1 comment

Comments

@saalaa
Copy link
Owner

saalaa commented Aug 29, 2018

Very long decorators look messy when they contain plenty of arguments. The situation should at least be improved through proper formatting (just like for function declarations) but adding the possibility to to disable them could be needed as well.

For example, consider the following code snippet:

@endpoints.api(name='greetings', version='v1')
class HelloWorldApi(remote.Service):
    @endpoints.method(
        MULTIPLY_METHOD_RESOURCE,
        Greeting,
        path='hellogreeting/{times}',
        http_method='POST',
        name='greetings.multiply'
    )
    def greetings_multiply(self, request):
        return Greeting(message=request.message * request.times)
@saalaa
Copy link
Owner Author

saalaa commented Aug 29, 2018

Here's a sample of the produced documentation:

screenshot from 2018-08-29 20-54-32

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

1 participant