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

Disallowed XML characters in typescript comments should be XML-escaped #418

Closed
baronfel opened this issue Jul 27, 2021 · 4 comments
Closed

Comments

@baronfel
Copy link

Given this generated comment from the vscode API, the angle-brackets should have been translated as &gt; and &lt; instead of > and <. If this doesn't happen, the XML is invalid and FS3390 is fired.

/// <summary>Register a {@link NotebookSerializer notebook serializer}.
/// 
/// A notebook serializer must be contributed through the `notebooks` extension point. When opening a notebook file, the editor will send
/// the `onNotebook:<notebookType>` activation event, and extensions must register their serializer in return.</summary>
/// <param name="notebookType">A notebook.</param>
/// <param name="serializer">A notebook serialzier.</param>
/// <param name="options">Optional context options that define what parts of a notebook should be persisted</param>
abstract registerNotebookSerializer: notebookType: string * serializer: NotebookSerializer * ?options: NotebookDocumentContentOptions -> Disposable
@baronfel baronfel changed the title Disallowed XML characters in typescript comments should be XL-escaped Disallowed XML characters in typescript comments should be XML-escaped Jul 27, 2021
@Booksbaum
Copy link
Contributor

Should work since #408

    /// <summary>
    /// Register a <see cref="NotebookSerializer">notebook serializer</see>.
    /// 
    /// A notebook serializer must be contributed through the <c>notebooks</c> extension point. When opening a notebook file, the editor will send
    /// the <c>onNotebook:&lt;notebookType&gt;</c> activation event, and extensions must register their serializer in return.
    /// </summary>
    /// <param name="notebookType">A notebook.</param>
    /// <param name="serializer">A notebook serialzier.</param>
    /// <param name="options">Optional context options that define what parts of a notebook should be persisted</param>
    /// <returns>A <see cref="Disposable" /> that unregisters this serializer when being disposed.</returns>
    abstract registerNotebookSerializer: notebookType: string * serializer: NotebookSerializer * ?options: NotebookDocumentContentOptions -> Disposable

(using https://fable.io/ts2fable/ )

Are you sure you're using the current version?
(Your example additionals misses transforms of link, code, and return tag)

@baronfel
Copy link
Author

baronfel commented Aug 3, 2021

I'm using the cli tool from npm, which is at version 0.7.1. Is that ok?

@baronfel
Copy link
Author

baronfel commented Aug 3, 2021

It looks like I should be using ts2fable@next instead?

@baronfel
Copy link
Author

baronfel commented Aug 3, 2021

yep, that worked great. thanks for the pointer!

@baronfel baronfel closed this as completed Aug 3, 2021
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

No branches or pull requests

2 participants