Bump fsdocs-tool from 23.0.0-alpha.7 to 23.0.0-alpha.8 - #1023
Open
dependabot[bot] wants to merge 1 commit into
Open
dependabot[bot] wants to merge 1 commit into
dependabot[bot] wants to merge 1 commit into
Conversation
--- updated-dependencies: - dependency-name: fsdocs-tool dependency-version: 23.0.0-alpha.8 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated fsdocs-tool from 23.0.0-alpha.7 to 23.0.0-alpha.8.
Release notes
Sourced from fsdocs-tool's releases.
23.0.0-alpha.8
Added
Tool tips on F# snippets are syntax highlighted. The compiler hands a signature over as runs it has already classified, and
ToolTipReaderwas flattening them into one string, soval printfn: format: Printf.TextWriterFormat<'T> -> 'Trendered as undifferentiated text. The runs keep their classification now and a tip is colored by the same--code-*rules as the snippet it describes, so a keyword, a type, a function and a type parameter look the same whether you read them in the code or in the tip. #1336A signature too wide for its tool tip is laid out over several lines instead of wrapping wherever the line runs out. It breaks after the name, after each parameter and before the result, the parameters indented under the name and the result under them, the way a formatter would write it. The compiler's own parser decides where those points are, so the breaks land on syntax rather than a guess, and a line that fits, or that is not a signature, is left as it was. Nearly every line this touched was a member of a type: one with six optional parameters ran to 600 characters. #1336
Changed
A tool tip opens with the doc comment and the signature follows it, where the signature used to come first. The doc text is shown in the color a comment has in a snippet. #1336
Code snippets are no longer laid out with a table. A snippet is a
<div class="fsdocs-snippet">holding one<pre class="fsdocs-snippet-lines">for the line numbers and one<pre class="fssnip">for the code, placed side by side with CSS grid. Markdown code blocks, notebook output and non-F# snippets use the same wrapper, so one selector covers every code block on the page. A stylesheet that targetstable.pre,td.lines,td.snippet, or the.code-block-wrapperthe copy button used to insert, needs updating, and a script that looks for a snippet, such as the Mermaid recipe in the documentation, should look for.fsdocs-snippetinstead oftable.pre. #1336Line numbers lost the
:suffix and sit in a column markedaria-hidden, so a screen reader reads the code and not the numbering. The code column scrolls on its own, so the line numbers stay in view while a wide snippet scrolls. #1336The default stylesheet ships a new syntax palette built from GitHub's light and dark hues. The previous one had grown a separate hue per token kind, eight of them teal or purple, on top of a dark green default text color in light mode. Tokens are grouped into roles instead: keywords, types, the modules and namespaces that hold them, callables, values, strings, and one mute for comments, fsi output, inactive code and line numbers. Modules take the green GitHub reserves for tags, so
List.map String.trimreads as container then function rather than one orange run. Identifiers, operators and punctuation read as plain text. Every color is a--code-*custom property, so a site can restyle the whole scheme without touching a selector. #1336ToolTipSpangained aToken of kind: TokenKind * body: stringcase for a classified run of tool tip text, andToolTipReader.stripParameterAttributesnow takes and returns those runs instead of a string. Code that matches onToolTipSpanhas to handle the new case. #1336Fixed
A type abbreviation in a tool tip was colored as an identifier rather than as a type, so
intandboolwere orange whilestring,option,list,arrayandunitwere plain, in the same position of the same signature. The compiler tags an abbreviation apart from the type it stands for, and the tag was being grouped with parameters and locals. TheSystem.qualifier of a fully written name takes the module color instead of plain for the same reason. #1336A tool tip lost every line break in the signature it was showing. The compiler does not hand the break over in a tag of its own, it arrives inside a
TextorSpacerun with the indentation of the next line attached, and only theSpacecase was split on. A tip is flowing text, so the browser collapsed the rest andtype List<'T>ran its cases, interfaces and members together on one line. #1336A doc comment reached the tool tip as the raw XML it was written as, so
<summary>and<param>tags showed up in the tip. The comment is read as XML now and a<see cref="..."/>keeps the name it points at, rather than leaving a hole in the sentence it sits in. #1336Several syntax token classes had no matching rule in the default stylesheet and were rendered in the plain code color: union cases (
uc), F# preprocessor directives (pp), escaped characters (esc), enumeration cases (en), mutable bindings (mv), and identifiers in every non-F# language (i), which is the bulk of a C#, JavaScript, TypeScript or HTML snippet. The stylesheet was matchingu,prep,eandv, names the formatters stopped emitting. Compiler errors (cerr) and omitted code (omitted) are styled for the first time. #1336A code block rendered from an
OtherBlockopened its wrapper element without ever closing it, leaving unbalanced HTML on the page whenever code snippet wrapping was on. #1336Commits viewable in compare view.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)