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

Linking to other types #52

Closed
forki opened this issue Oct 26, 2013 · 3 comments
Closed

Linking to other types #52

forki opened this issue Oct 26, 2013 · 3 comments

Comments

@forki
Copy link
Member

forki commented Oct 26, 2013

Hi,

I would like to link to other types or functions from the API docs.

type MyTape = int

/// This returns a [MyType].
let f x :MyType = x * 2

Maybe this introduces magic, but it still looks a bit like ordinary markdown linking.

@tpetricek
Copy link
Member

This is certainly a planned thing. I was thinking about doing this automatically whenever you use MyType and there is a non-ambiguous identifier that matches the name. (If I understand it correctly, the original FsHtml tool even knew which namespaces were open, but I'm not entirely sure).

@forki
Copy link
Member Author

forki commented Oct 28, 2013

Auto-Linking might lead to strange links.

@matthid
Copy link
Member

matthid commented Mar 23, 2017

#330

@matthid matthid closed this as completed Mar 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants