From f4014fb46c7df9c10ad6250646e949ca158d0cf3 Mon Sep 17 00:00:00 2001 From: Brian Rourke Boll Date: Tue, 18 Jun 2024 17:42:41 -0400 Subject: [PATCH 1/5] Align examples * Shrink the example heading font size a bit. * Align the example with the rest of the summary/details. --- docs/content/fsdocs-default.css | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/content/fsdocs-default.css b/docs/content/fsdocs-default.css index 825e598b..6e1f615e 100644 --- a/docs/content/fsdocs-default.css +++ b/docs/content/fsdocs-default.css @@ -1127,7 +1127,7 @@ span[onmouseout] { margin-bottom: var(--spacing-200); } - .fsdocs-returns, .fsdocs-params { + .fsdocs-returns, .fsdocs-params, .fsdocs-example-header, pre.fssnip.highlighted { margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); &:first-child { @@ -1147,6 +1147,10 @@ span[onmouseout] { margin: var(--spacing-200) 0; } + .fsdocs-example-header { + font-size: var(--font-200); + } + > div.fsdocs-summary { display: flex; flex-direction: row; From 71c985a496d11f02fb3e953aa1ca8bbdf0fb43ca Mon Sep 17 00:00:00 2001 From: Brian Rourke Boll Date: Wed, 19 Jun 2024 10:00:38 -0400 Subject: [PATCH 2/5] Improve API doc content alignment consistency --- docs/content/fsdocs-default.css | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/docs/content/fsdocs-default.css b/docs/content/fsdocs-default.css index 6e1f615e..0faaf6a1 100644 --- a/docs/content/fsdocs-default.css +++ b/docs/content/fsdocs-default.css @@ -1083,6 +1083,23 @@ span[onmouseout] { display: flex; flex-direction: column; justify-content: flex-start; + + > * { + margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); + + &:first-child:is(.icon-button-row) { + margin-top: 0; + margin-bottom: 0; + } + + &:nth-child(2) { + margin-top: 0; + } + + &:last-child { + margin-bottom: 0; + } + } } .icon-button-row { @@ -1099,8 +1116,6 @@ span[onmouseout] { counter-increment: list-item 0; list-style: disclosure-closed outside; cursor: pointer; - width: calc(100% - var(--spacing-300)); - margin-left: var(--spacing-300); > .fsdocs-summary { display: flex; @@ -1127,9 +1142,14 @@ span[onmouseout] { margin-bottom: var(--spacing-200); } - .fsdocs-returns, .fsdocs-params, .fsdocs-example-header, pre.fssnip.highlighted { + & details > * { margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); + &:is(summary) { + margin-top: 0; + margin-bottom: 0; + } + &:first-child { margin-top: 0; } From 5daf0d107bc3fc587c89deb3846f6b8e7e2c6f47 Mon Sep 17 00:00:00 2001 From: Brian Rourke Boll Date: Wed, 19 Jun 2024 10:10:03 -0400 Subject: [PATCH 3/5] Use `margin-block` --- docs/content/fsdocs-default.css | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/content/fsdocs-default.css b/docs/content/fsdocs-default.css index 0faaf6a1..7dea2286 100644 --- a/docs/content/fsdocs-default.css +++ b/docs/content/fsdocs-default.css @@ -1088,8 +1088,7 @@ span[onmouseout] { margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); &:first-child:is(.icon-button-row) { - margin-top: 0; - margin-bottom: 0; + margin-block: 0; } &:nth-child(2) { @@ -1146,8 +1145,7 @@ span[onmouseout] { margin: var(--spacing-200) 0 var(--spacing-200) var(--spacing-300); &:is(summary) { - margin-top: 0; - margin-bottom: 0; + margin-block: 0; } &:first-child { From 007cf691875bbc9d75a7137bed87f755add21805 Mon Sep 17 00:00:00 2001 From: Brian Rourke Boll Date: Wed, 19 Jun 2024 10:11:31 -0400 Subject: [PATCH 4/5] Update release notes --- RELEASE_NOTES.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 93921f49..31db1e3e 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,5 +1,11 @@ # Changelog +## 21.0.0-beta-002 - 2024-06-19 + +### Changed +* Shrink API docs example heading font size a bit. +* Improve overall API doc content alignment consistency in various scenarios. + ## 21.0.0-beta-001 - 2024-06-06 ### Added From d6762c33c849214290dcc1dfa03826a0cd8ed873 Mon Sep 17 00:00:00 2001 From: Brian Rourke Boll Date: Wed, 19 Jun 2024 10:15:04 -0400 Subject: [PATCH 5/5] Add PR link --- RELEASE_NOTES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 31db1e3e..ef54b1e4 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -3,8 +3,8 @@ ## 21.0.0-beta-002 - 2024-06-19 ### Changed -* Shrink API docs example heading font size a bit. -* Improve overall API doc content alignment consistency in various scenarios. +* Shrink API docs example heading font size a bit. [#923](https://github.com/fsprojects/FSharp.Formatting/pull/923) +* Improve overall API doc content alignment consistency in various scenarios. [#923](https://github.com/fsprojects/FSharp.Formatting/pull/923) ## 21.0.0-beta-001 - 2024-06-06