-
Notifications
You must be signed in to change notification settings - Fork 605
Updated default empty description for body params #778
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
Conversation
Updated the default description so that if none is provided it'll automatically populate based on the field name
@chrispage1 this project isn't maintained anymore. Here's the maintained fork, with more features and better presentation: https://github.com/knuckleswtf/scribe
Your idea sounds good (although it can be argued that it's just as obvious by leaving the parameter name). Consider making a PR to Scribe instead, and we can discuss it there.
@shalvah thanks for the heads up. I'll take a look at this package 👍
Having a quick play and I can see there isn't actually a need for this PR in scribe so that's good!
Uh oh!
There was an error while loading. Please reload this page.
After having a play with the project - which is brilliant, it seems logical to me to take the default parameter names and explode them out to provide a default description. This way for a majority of fields no description has to be provided unless the user chooses to override this value.
Before:
image
After:
image
I hope you can see a use for this! Thanks.