Giter Site home page Giter Site logo

Comments (8)

shalvah avatar shalvah commented on August 23, 2024 1

Tried it just today, and it works: https://shalvah.me/TheCensorshipAPI/#add-a-word-to-the-list

Also, you should put code snippets on GitHub in code blocks (```). Was hard to understand you for a while.

from scribe.

shalvah avatar shalvah commented on August 23, 2024 1

Place your annotations (@group, @authenticated, etc) after your title and description (plus a blank line). It's not by design, but changing that breaks other things.

from scribe.

pirex360 avatar pirex360 commented on August 23, 2024

I dont understand why do not work with me....
I can put HTML and works well in the 'intro_text' in scribe.php config dir.
But in the endpoint documentation... it just ignores, i cant put even a badge.

I use "knuckleswtf/scribe": "^1.1" in composer.json

Ok, thanks for the tip about code.

from scribe.

shalvah avatar shalvah commented on August 23, 2024

Have you tried updating to the latest version?

from scribe.

pirex360 avatar pirex360 commented on August 23, 2024

Updated now 1.3.0 , "knuckleswtf/scribe": "^1.3.0",
...
but result is the same !

Screenshot 2020-07-17 at 18 21 22

from scribe.

pirex360 avatar pirex360 commented on August 23, 2024

Hi there,
Now some endpoints ignore text description.
It misses "List all Days from two dates by Specialities PHC. " in this example :

Screenshot 2020-07-24 at 09 39 47

My result after php artisan scribe:generate

Screenshot 2020-07-24 at 09 39 37

from scribe.

pirex360 avatar pirex360 commented on August 23, 2024

:) Congratulations ....

It fixes all, even the HTML is render perfect.

Thanks you, where do I find this rule/best practice in documentation ? if it's not there... it should be.

Once again, thanks.

from scribe.

shalvah avatar shalvah commented on August 23, 2024

Added a note about it to the docs: https://scribe.readthedocs.io/en/latest/documenting/documenting-endpoint-metadata.html

from scribe.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.