Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Omits extension methods module from documentation #1

Closed
wants to merge 1 commit into from
Closed

Omits extension methods module from documentation #1

wants to merge 1 commit into from

Conversation

edhzsz
Copy link

@edhzsz edhzsz commented Jun 10, 2015

If you add [omit] to the extension methods' modules FSharp.Formating will not try to generate documentation for them and it will not fail.
In this way you won't have to disable and enable extension methods in order to generate docs.

If you add [omit] to the extension methods' modules  FSharp.Formating will not try to generate documentation for them and it will not fail.
In this way you won't have to disable and enable extension methods in order to generate docs.
@matthid
Copy link
Owner

matthid commented Jun 10, 2015

Nice find, thank for bringing that to my attention!
I'll leave that open for now as a reminder for me as I'm currently a bit time limited (relocating to a new workplace). And I think I have other places (projects) where I should do this, so thanks again!

@edhzsz
Copy link
Author

edhzsz commented Jun 10, 2015

You are welcome!
I found it while adding an Extension Method to FSharp.MetadataFormat in FSharp.Formating.

@matthid
Copy link
Owner

matthid commented Sep 13, 2015

Sadly it doesn't seem to help in my case (see AppVeyor build)... I think I'm going to go bug hunting in FCS now :) (or at least find a workaround for FSF)

@matthid
Copy link
Owner

matthid commented Sep 19, 2015

Ok I figured it out: [omit] is not working with markDownComments set to false (fsprojects/FSharp.Formatting#201).

@edhzsz edhzsz closed this Oct 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants