search

mpociot / laravel-apidoc-generator

Laravel API Documentation Generator
https://beyondco.de/docs/laravel-apidoc-generator/
MIT License
3.43k stars 614 forks source link

Updated default empty description for body params #778

Closed chrispage1 closed 7 months ago

chrispage1 commented 4 years ago

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.

shalvah commented 4 years ago

@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.

chrispage1 commented 4 years ago

@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!