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

Documentation of FAKE 5 API (cosmetic). #2017

Closed
Rodhern opened this issue Jul 6, 2018 · 3 comments
Closed

Documentation of FAKE 5 API (cosmetic). #2017

Rodhern opened this issue Jul 6, 2018 · 3 comments
Labels

Comments

@Rodhern
Copy link
Contributor

Rodhern commented Jul 6, 2018

I see this text in The FAKE 5 Migration Guide:

... if you use Target.Create, but ...

So I look up Fake.Core.Target . There is a function there called create listed as create(name body).

I don't think it is completely consistent in the guide and documentation when a method is spelled with an initial lower case letter and when an upper case letter is used.

Anyway the thing that caught my eye is the parenthesis. If you are used to F#, when you see, create(name body), you may wonder if name is a function, when in this case it is a string. Maybe it is a standard way to describe APIs that I don't know. Is it done like this on purpose?

@matthid
Copy link
Member

matthid commented Jul 6, 2018

Yes both are wrong unfortunately.
Obviously it needs to be Target.create as that is what we use now.

An yes the parenthesis are wrong it should probably read create name body...

@matthid
Copy link
Member

matthid commented Jul 22, 2018

I think the problem is FSharp.Formatting and I reported the bug here: fsprojects/FSharp.Formatting#472

@matthid
Copy link
Member

matthid commented Jul 29, 2018

Thanks for the report. Apparently this was a bug in modules with RequireQualifiedAccess attribute (which is now used throughout the code-base). How it will look in the next release can be checked on https://staging.fake.build/apidocs/v5/fake-io-file.html

It is still not perfect - especially the shortened version with (...) - as there are still braces. But you can read that as partial application (and it is not "wrong" in that sense)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants