typography/text-style.scssにSassDocを添付

pepabo · Jan 20, 2025 · 57f7adb · 57f7adb
1 parent bb96d22
commit 57f7adb
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/adapter/functions/typography/_text-style.scss b/packages/adapter/functions/typography/_text-style.scss
@@ -1,6 +1,13 @@
 @use "./font-size";
 @use "./line-height";
 
+/// font-sizeとline-heightのリストを取得します。
+/// ※ Sassのリスト型として取得されるので、使うことはほぼなさそうです。代わりに `text()` の利用を検討してください。
+///
+/// @group typography
+/// @example
+///   functions.get-text-style($level: m, $density: normal)
+///   // (font-size: 1rem, line-height: 1.5rem)
 @function get-text-style($density: normal, $level: m) {
   $value: (
     font-size: font-size.get-font-size($level),