Some features adjustment on MetadataFormat #64

soloman817 · 2013-11-08T01:49:00Z

I modified these issues:

Added F# special member for type: UnionCase and RecordField, they are listed as members in Type;
Make some change in displaying the members' usage (all because in real project, TypeName usually is very long):
- For constructor, use "new(arg1, arg2, ...)" instead of "new TypeName" because in real project, TypeName usually is very long.
- For instance members, discard the instance name, just show the method name and its arguments;
- For static methods, discard the type name.
Modifed the templates to show the special members of type, and also list nested types in module.

I also find another bug, that the private constructor is also listed. I traced this problem and find that it is a FSharpPowerPack.Metadata problem, so I also make a FSharpPowerPack repo, and fixed it by just one line, you can check that here: soloman817/FSharpPowerPack@05182d5

tpetricek · 2013-11-08T05:22:19Z

Wow, great work!! :-) I'll test & merge this tomorrow.

soloman817 · 2013-11-08T05:33:57Z

Hi Tomas,

Good you like it. Here is the manual I build for Alea.cuBase:
http://www.aleacubase.com/temp/manual/

You can click the "Reference" link to see the doc generated by my
modification of your formating library.

To apply the fixed PowerPack.Metadata.dll, you can clone my repo and just
build the PowerPack.Metadata.dll and then replace the one in fsformatting
project.

Regards,
Xiang.

On Fri, Nov 8, 2013 at 1:22 PM, Tomas Petricek notifications@github.comwrote:

Wow, great work!! :-) I'll test & merge this tomorrow.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/64#issuecomment-28036656
.

soloman817 · 2013-11-08T05:36:41Z

example of union case:
http://www.aleacubase.com/temp/manual/reference/alea_cuda/alea-cuda-common-compileerror.html

example of record fields:
http://www.aleacubase.com/temp/manual/reference/alea_cuda/alea-cuda-common-compileoptions.html

example of nested types:
http://www.aleacubase.com/temp/manual/reference/alea_cuda/alea-cuda-engine.html

On Fri, Nov 8, 2013 at 1:22 PM, Tomas Petricek notifications@github.comwrote:

Wow, great work!! :-) I'll test & merge this tomorrow.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/64#issuecomment-28036656
.

tpetricek · 2013-11-08T07:21:20Z

Nice! I'm glad other people are finding F# formatting useful. I'll run this on the Deedle documentation (which has some records & discriminated unions) too. Thanks very much for the contribution!

soloman817 · 2013-11-08T07:24:42Z

Thank you providing such a good tool. This is the best one for F# :)

On Fri, Nov 8, 2013 at 3:21 PM, Tomas Petricek notifications@github.comwrote:

Nice! I'm glad other people are finding F# formatting useful. I'll run
this on the Deedle documentation (which has some records & discriminated
unions) too. Thanks very much for the contribution!

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/64#issuecomment-28041771
.

ovatsus · 2013-11-08T09:52:39Z

Cool, if I read this right, it will allow to document JsonValue properly in FSharp.Data

Some features adjustment on MetadataFormat

tpetricek · 2013-11-11T09:51:58Z

Released in version 2.2.7-beta (labeled as beta mainly because I made some other unrelated beta changes on my machine - it should not break anything, but who knows :-))

I also have not imported the changes in PowerPack yet - I'm wondering what's the best way to do that. Perhaps we should just copy the code from PowerPack and have it directly in the repository here? (I think it is unlikely that anyone else would want to maintain that...) Thoughts @ovatsus @dsyme @forki?

forki · 2013-11-11T10:03:25Z

If there is no license problem, then I'd suggest copy it over.

forki · 2013-11-11T10:13:32Z

I'm getting an invalid cast exception. Ideas?

fsprojects/FAKE@95725d4

soloman817 · 2013-11-11T10:16:49Z

This seems to be a Razor template problem, you need a little trace into the
template, I think you might used a customized template, right?

Also, I think I forgot one thing, if there is a generic type (not nested),
the template should do HTML encoding like
@Html.Encode(typeName)
Because generic type name contains "<"

On Mon, Nov 11, 2013 at 6:13 PM, Steffen Forkmann
notifications@github.comwrote:

[image: image]https://f.cloud.github.com/assets/57396/1511807/de175594-4ab9-11e3-8c04-3891e2eb6d74.png

I'm getting an invalid cast exception. Ideas?

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/64#issuecomment-28187408
.

soloman817 · 2013-11-11T10:20:08Z

So for example, I used following razor template in my project (not in this pull request):

            <ul class="nav nav-list" id="menu">
                @(((IDictionary<string, string>)ViewBag.Properties)["nav-list"])
            </ul>

So, from your error screenshot, you are reading view bag Properties, you should use correct cast I think.

ovatsus · 2013-11-11T10:44:17Z

I'd also suggest that you just copy the file from powerpack

forki · 2013-11-11T10:59:44Z

@soloman817 I get the same error with the default templates

soloman817 · 2013-11-11T11:11:38Z

could you send the dll to me via soloman817@gmail.com

forki · 2013-11-11T11:19:02Z

It might be easier to clone fsprojects/FAKE@95725d4 and run build.cmd

soloman817 · 2013-11-11T11:25:15Z

ok, let me have a try.

On Mon, Nov 11, 2013 at 7:19 PM, Steffen Forkmann
notifications@github.comwrote:

It might be easier to clone fsprojects/FAKE@95725d4fsprojects/FAKE@95725d4and run build.cmd

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/64#issuecomment-28190953
.

soloman817 · 2013-11-11T12:10:15Z

@forki I confirmed, this problem is because you used things like @Root or @Properties in your template.

Here is the step I debug this problem:

I replaced every place in your templates that has:
- @Root
- @Properties[...]
- Properties[...]

Then I can pass the build, but once if I added a @Root then it will fail.

I think I also met this problem when using Properties, in my code I have to use this ugly code:
@(((IDictionary<string, string>)ViewBag.Properties)["nav-list"])

Because I traced into the code, the Properties is created as a dictionary, but must cast it down. Well I'm not very good at dynamic .NET, could @tpetricek check this? I think this is not a problem raised by my commits, this is about how to use the dynamic view bag stuff in the template which I'm not very familiar.

Regards,
Xiang.

tpetricek · 2013-11-12T14:25:33Z

I'll have a look. Razor is quite odd, but I think it might be fixed if I change how the dictionaries are created.

ovatsus · 2013-11-18T23:59:10Z

I updated FSharp.Data to 2.2.7-beta, but I'm still not getting the Union Cases section in JsonValue, even after manually changing types.cshtml to include them (https://github.com/fsharp/FSharp.Data/blob/master/docs/tools/reference/type.cshtml#L16)
What am I missing?
I also don't get any razor related problem

ovatsus · 2013-11-19T00:01:09Z

@soloman817 How do you specify the docs for the record fields in the source code to generate this (http://www.aleacubase.com/temp/manual/reference/alea_cuda/alea-cuda-common-compileoptions.html)
VS Intellisense doesn't seem to pick it up (see http://stackoverflow.com/questions/20016568/xml-documentation-for-interface-methods-and-record-properties)

soloman817 · 2013-11-19T04:01:08Z

@ovatsus The UnionCase is parsed by FSharp.PowerPack.Metadata, so it should be there, and make sure you use fsharp 3.0+ (by running the script with Developer Prompt VS2012 or 2013).

The following code generates this page

/// Compiling options.
type CompileOptions =
    {
        /// The module name. If a module is used as library, it _must_ be assigned with a module name.
        ModuleName : string
        AddressSize : AddressSize
        MinimalArch : DeviceArch
        VarDebug : bool
        FixInlineFunctionIssue : bool

        LinkageG : bool
        LinkageOpt : LinkageOpt
        LinkageFTZ : bool
        LinkagePrecSqrt : bool
        LinkagePrecDiv : bool
        LinkageFMA : bool

        JITMaxRegisters : int option
        JITCacheMode : JITCacheMode option
    }

Another example generate this page

/// CUDA JIT compiling cache mode.
type JITCacheMode =
    /// Compile with L1 cache disabled.
    | CG
    /// Compile with L1 cache enabled.
    | CA

But I'm using VS2012, don't know if it work with open source fsharp.

tpetricek · 2013-11-28T00:50:48Z

@forki @soloman817 I tried reproducing the error mentioned above (when building FAKE) but it works fine with the latest master of FSharp.Formatting. Can you please open a separate issue if you get the above error again?

The latest master also includes union cases & records in AllMembers so it will work with the default templates.

The default templates use AllMembers to group things by categories. My earlier check-in (96f46d1) removed old version of the templates (that I was not using and not maintaining) but which included fix from @soloman817 to render the union cases/record members.

@soloman817 I would be happy to include a version of templates that do not use LINQ to group by categories, but I think I can only reasonably maintain one version - but if you can add them and add a MetadataFormat test that uses them, that would be perfect (if your project fits better with this simpler version of the templates).

soloman817 · 2013-11-28T01:17:13Z

@forki @tpetricek I remembered that the reproducing happens in one branch, not master. But yes, @forki you should open a new issues, and better write down how to reproduce this problem.

@tpetricek absolutely you should only maintain one template. The problem is I went to the wrong template from the beginning. I will adjust my project to using the LINQ one later.

soloman817 added 4 commits November 6, 2013 14:47

Support UnionCase and RecordField.

c5d02b6

Make method name shorter

e80ac05

Reduce constructor strings

179a4f0

Add a title for nested types

492ac3b

tpetricek added a commit that referenced this pull request Nov 11, 2013

Merge pull request #64 from soloman817/master

dbc9702

Some features adjustment on MetadataFormat

tpetricek merged commit dbc9702 into fsprojects:master Nov 11, 2013

tpetricek mentioned this pull request Nov 14, 2013

Something is wrong with Properties property in Razor #65

Closed

ovatsus referenced this pull request Nov 25, 2013

Update release and docs, include MathJax, remove old templates

96f46d1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Some features adjustment on MetadataFormat #64

Some features adjustment on MetadataFormat #64

soloman817 commented Nov 8, 2013

tpetricek commented Nov 8, 2013

soloman817 commented Nov 8, 2013

soloman817 commented Nov 8, 2013

tpetricek commented Nov 8, 2013

soloman817 commented Nov 8, 2013

ovatsus commented Nov 8, 2013

tpetricek commented Nov 11, 2013

forki commented Nov 11, 2013

forki commented Nov 11, 2013

soloman817 commented Nov 11, 2013

soloman817 commented Nov 11, 2013

ovatsus commented Nov 11, 2013

forki commented Nov 11, 2013

soloman817 commented Nov 11, 2013

forki commented Nov 11, 2013

soloman817 commented Nov 11, 2013

soloman817 commented Nov 11, 2013

tpetricek commented Nov 12, 2013

ovatsus commented Nov 18, 2013

ovatsus commented Nov 19, 2013

soloman817 commented Nov 19, 2013

tpetricek commented Nov 28, 2013

soloman817 commented Nov 28, 2013

Some features adjustment on MetadataFormat #64

Some features adjustment on MetadataFormat #64

Conversation

soloman817 commented Nov 8, 2013

tpetricek commented Nov 8, 2013

soloman817 commented Nov 8, 2013

soloman817 commented Nov 8, 2013

tpetricek commented Nov 8, 2013

soloman817 commented Nov 8, 2013

ovatsus commented Nov 8, 2013

tpetricek commented Nov 11, 2013

forki commented Nov 11, 2013

forki commented Nov 11, 2013

soloman817 commented Nov 11, 2013

soloman817 commented Nov 11, 2013

ovatsus commented Nov 11, 2013

forki commented Nov 11, 2013

soloman817 commented Nov 11, 2013

forki commented Nov 11, 2013

soloman817 commented Nov 11, 2013

soloman817 commented Nov 11, 2013

tpetricek commented Nov 12, 2013

ovatsus commented Nov 18, 2013

ovatsus commented Nov 19, 2013

soloman817 commented Nov 19, 2013

tpetricek commented Nov 28, 2013

soloman817 commented Nov 28, 2013