Coder Social home page Coder Social logo

Comments (1)

jsarchibald avatar jsarchibald commented on June 19, 2024

It's implied in the documentation that we can only use the :type: syntax if we're referencing a type we've defined in the documentation. Problem is, if we define the types in the documentation ourselves, then the definitions will also appear in our docs, and we'll have to deal with a list of C types at the bottom of the page.

For now, I think the simplest solution is to just change :type: to :code: where it appears. The only drawback is aesthetics, since the text will be red, not black. (There was no actual cross-reference to a type before, so no link is disappearing; the only difference is the text color.)
image

I've also posted a question on Stack Overflow (here) so will wait to see if the internet has any alternatives that I haven't thought of.

from cs50.readthedocs.io.

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.