Comments (9)
We already have an example like that in https://develop.url.cpp.al/url/parsing/authority.html#url.parsing.authority.authority_view
from url.
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.
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:
(the overview could still improve though)
Maybe we have a different idea for that, but isolating authority view in the TOC looked quite ugly:
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.
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.
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.
"Documentation can always be improved."
Get the information into the docs, and we can worry how to make it pretty later.
from url.
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.
What I mean is we can live with it the way it is now...and worry about making it better later.
from url.
I support that :)
from url.
Related Issues (20)
- Boost.URL as subproject should not automatically add dependencies
- Boost CMake testing procedure doesn't work for URL
- Reconfiguring with BUILD_TESTING=OFF doesn't disable tests
- `boost::urls::resolve` gives wrong result when there are more `..`s in relative reference HOT 6
- sanitize_uri moves host to path
- Slash in query param not being encoded as %2F HOT 5
- docs build tmp files HOT 4
- UB Sanitizer implicit-integer-sign-change warning in boost::urls::grammar::detail::find_if_not_pred HOT 6
- Missing coverage
- Source files should not include header guards
- coverage job is generating an empty file
- detail symbol in reference
- Missing codecov token in GHA
- Improve coverage
- When compiling the boost.url libs comes the errors HOT 3
- Exclude tests from Antora compile commands
- craypp crash compiling segments_view.cpp HOT 1
- Test libraries and executables should be declared EXCLUDE_FROM_ALL
- Fix security vulnerabilities detected in Antora docs HOT 1
- Fix urls::errc reference
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from url.