search

knuckleswtf / scribe

Generate API documentation for humans from your Laravel codebase.✍
https://scribe.knuckles.wtf/laravel/
MIT License
1.59k stars 280 forks source link

No line break for @responseField description for long descriptions #747

Open excitexcite opened 8 months ago

excitexcite commented 8 months ago

Scribe version

4.25

PHP version

8.2.0

Framework

Laravel

Framework version

10.10

Scribe config

------ SAME AS DEFAULT CONFIG ------

What happened?

Have a need to specify long (multiline) @responseField descriptions (not a one-time case). When I add long multiline @responseField description, it goes out of the request area. Noticed that there is not such problem in demo (https://demo.scribe.knuckles.wtf/). As far as I understand, in demo containing

element has 

margin-right: 50%;  
padding: 0 28px;

whereas in actual version (4.25) it's replaced for a <div style=" padding-left: 28px; clear: unset;"> .

Screen from actual version image Screen from demo (a bit modified with devtools to illustrate problem more precisely) image

Sorry, if i got something wrong and It's not a bug, but some error of mine

Docs

shalvah commented 6 months ago

Hmmm, thanks for the report. How are you doing multiline? There has to be one blank line in between, I think.