Comments (12)
My 2 cents: it would only make sense on pages with API docs and should not be part of the menu bar.
from fsharp.formatting.
Hmm, still some remaining problems with the new approach:
from fsharp.formatting.
Something like this?
Yeah, exactly. To me that’s more intuitive.
from fsharp.formatting.
Sounds reasonable, go for it!
from fsharp.formatting.
@nojaf Hmm, I'll look.
Separately, I'm noticing else on that same page that will necessitate some additional tweaks in that area anyway.
The .fsdocs-entity-xmldoc { > div { flex-direction: row reverse } }
, which was already there, affects the order of any paragraphs defined with <para>
that are nested in the <summary>
.
So these paragraphs —
/// <summary>
/// <para>
/// Parse and check a source code file, returning a handle to the results
/// </para>
/// <para>
/// Note: all files except the one being checked are read from the FileSystem API
/// </para>
/// <para>
/// Return FSharpCheckFileAnswer.Aborted if a parse tree was not available.
/// </para>
/// </summary>
— are shown in reverse order as
I think they should at least be shown in the order in which they're written, and it would probably be better if they were separated vertically instead of horizontally.
from fsharp.formatting.
Hmm, yeah, you're right. That row reverse was probably there for a reason. I'm okay with changing it, but we might need to consider any other issues it could introduce.
from fsharp.formatting.
Yeah, the contents themselves are generated in reverse order, only to be reversed again by the CSS, although I don't understand why:
FSharp.Formatting/src/FSharp.Formatting.ApiDocs/GenerateHtml.fs
Lines 183 to 189 in 56b856b
from fsharp.formatting.
Hmm, still some remaining problems with the new approach:
Here's the explanation for this particular thing:
Sometimes the <div class="fsdocs-summary">
will be nested inside <details><summary>
, and sometimes it won't be:
FSharp.Formatting/src/FSharp.Formatting.ApiDocs/GenerateHtml.fs
Lines 271 to 277 in 56b856b
I removed the CSS for the bare div
case in my PR, because I didn't understand that there were these different cases.
That conditional actually also means that, if there is no <summary>
in the XML doc, there will be no source links, even if there are other elements:
I don't think there's a good reason not to show source links in such a case.
from fsharp.formatting.
If I did add an expand/collapse-all button, does this look like a reasonable place to put it? The idea would be for it to save your preference for the whole site to local storage, like the theme toggle.
expand-collapse.mp4
I guess it could also only be shown on pages that had API docs, but then would it still make sense to show it in the top right? Or somewhere else?
from fsharp.formatting.
If it’s easy, to me it seems more intuitive on the same row as “instance members”. For me it doesn’t seem obvious to look for this on the menu bar. I expect expand/collapse to be located closer to the elements it affects.
(But if this does not appeal to you ignore it).
from fsharp.formatting.
If it’s easy, to me it seems more intuitive on the same row as “instance members”. For me it doesn’t seem obvious to look for this on the menu bar. I expect expand/collapse to be located closer to the elements it affects.
Something like this?
expand-collapse-2.mp4
(Could also be with "Instance members" as you suggest instead of in the table header.)
from fsharp.formatting.
Implemented in #917, #919, #920.
from fsharp.formatting.
Related Issues (20)
- Directory.Build.props is ignored if there are no projects or solutions HOT 3
- SEO-optimization for new theme HOT 4
- Suggestion: init command
- Dark mode borders: too much contrast?
- Namespace description overflows content box
- Output font size on mobile safari is too big HOT 6
- Using testcontainers in a fsx script gives wrong output HOT 7
- Create a keyword/glossary site map
- add .dib notebook support HOT 6
- --watch expectation HOT 1
- Can FSharp.Formatting support documenting programs? HOT 1
- Enable `watch` server from arbitrary host HOT 4
- Is it possible to generate an HTML AST from Markdown? HOT 1
- Nesting Document Categories HOT 1
- Include images in documentation in generated content HOT 17
- Use signature-like for documenting the API HOT 6
- Making a change to `content/fsdocs-default.css` cause an infinite update loop
- Use `Ctrl+C` instead of allowing any key press to kill the process
- Replace `ApiDocMemberDetails` union with a record
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 fsharp.formatting.