Comments (12)
Fixed it. PR incoming
from fsharp.formatting.
For reference, BindHelpers is an internal module. Eg
[<AutoOpen>]
module Sutil.Bindings
///[omit]
[<AutoOpen>]
module BindHelpers =
// ..
from fsharp.formatting.
Hello, I can't say I know anything about this. I found both exclude
and omit
in https://github.com/fsprojects/FSharp.Formatting/blob/94e833aa3d741e70b75f7d3d8f52da44d364f59c/src/FSharp.Formatting.ApiDocs/GenerateModel.fs so there definitely is something about it.
I'm afraid you would have to debug that code to really know what is up.
from fsharp.formatting.
Verified that it doesn't work in 17.2 either
% dotnet --version
7.0.101
% dotnet fsdocs --version
fsdocs 17.2.0
I have tried:
///<exclude>
/// <exclude>
///<exclude/>
/// <exclude/>
/// <exclude> </exclude>
/// <exclude value="true">true</exclude>
From your link:
for e in doc.Elements(XName.Get "exclude") do
cmds.["exclude"] <- e.Value
for e in doc.Elements(XName.Get "omit") do
cmds.["omit"] <- e.Value
My guess is that either:
exclude
isn't being parsed intodoc.Elements
ore.Value
isn't set correctly for<exclude/>
orcmds ["exclude"]
is being ignored somewhere
If you're a maintainer, could you point me at the code that assigns/parses/builds doc.Elements
please?
from fsharp.formatting.
I'm writing a test for <exclude/>
and [omit]
from fsharp.formatting.
I can't really say I know anything more than you do at this point.
I found a let doc = XDocument.Load(xmlFile)
call in that same file, so interestingly enough it is grabbing the XML from a separate file and something embedded in the assembly, I guess.
Or not, I honestly don't know and won't be of much use here.
Good luck!
from fsharp.formatting.
OK :-) Well, I'm down the rabbit hole now - I'll keep at it. I don't have a lot of success with fsdocs.
from fsharp.formatting.
Thank you!
from fsharp.formatting.
OK, so part of the problem is that
/// A comment
/// <exclude/>
is parsed as
<summary>A comment<exclude/></summary>
This means a workaround is to explicitly tag the comment
/// <summary>
/// A comment
/// </summary>
/// <exclude/>
from fsharp.formatting.
Nested modules are still included though.
from fsharp.formatting.
PR submitted and passed checks
from fsharp.formatting.
Closed by #787
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
- Suggestion: auto-expansion of `<details>…</details>` for direct links HOT 12
- 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.