GithubHelp home page GithubHelp logo

Comments (9)

alandefreitas avatar alandefreitas commented on July 17, 2024

We already have an example like that in https://develop.url.cpp.al/url/parsing/authority.html#url.parsing.authority.authority_view

from url.

vinniefalco avatar vinniefalco commented on July 17, 2024

Nice! Since this is the use-case that 99% of people will need, I think we should reflect that in the section heading so they can find it in the table of contents.

from url.

alandefreitas avatar alandefreitas commented on July 17, 2024

We did have something like that, where authority_view had its own section. I merged the sections in some previous PR to make the TOC look a little better:

image
(the overview could still improve though)

Maybe we have a different idea for that, but isolating authority view in the TOC looked quite ugly:

image

This previous layout also made the relationship between authority and authority_view more complex to explain, less natural to the reader, and I'm not sure it's so helpful, since authority is already visible and it's the natural place to look for that kind of use case. But I don't know, maybe there's a better way I haven't considered yet.

from url.

vinniefalco avatar vinniefalco commented on July 17, 2024

isolating authority view in the TOC looked quite ugly:

Yes that image of the ToC looks bad. It repeats the word Authority. How about the heading "HTTP CONNECT" since that's usually what it is used with?

from url.

alandefreitas avatar alandefreitas commented on July 17, 2024

To be honest, the repeated word is something we can improve but not something I mind that much because this is likely to happen in this kind of document anyway.

What I don't like is

  • visually the snaggle-tooth as an exception for something that is really just a use case among many, and
  • how it conceptually affects the section hierarchy, because "authority view" is not even the last subsection of this section and this becomes a mess: the "Authority" section would include text that should come before and after the "Authority view"

But we can do anything. Just say the word.

from url.

vinniefalco avatar vinniefalco commented on July 17, 2024

"Documentation can always be improved."

Get the information into the docs, and we can worry how to make it pretty later.

from url.

alandefreitas avatar alandefreitas commented on July 17, 2024

Get the information into the docs, and we can worry how to make it pretty later.

The information is in the docs already. We are just discussing the presentation now.

"Documentation can always be improved."

At this point, we're not discussing an improvement. I think we're discussing whether this would make it worse.

from url.

vinniefalco avatar vinniefalco commented on July 17, 2024

What I mean is we can live with it the way it is now...and worry about making it better later.

from url.

alandefreitas avatar alandefreitas commented on July 17, 2024

I support that :)

from url.

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.