소스 검색

docstrings

sschmid 5 년 전
부모
커밋
1869c38351
1개의 변경된 파일5개의 추가작업 그리고 1개의 파일을 삭제
  1. 5 1
      src/OpenSheetMusicDisplay/OSMDOptions.ts

+ 5 - 1
src/OpenSheetMusicDisplay/OSMDOptions.ts

@@ -57,7 +57,11 @@ export interface IOSMDOptions {
     disableCursor?: boolean;
     /** Follow Cursor: Scroll the page when cursor.next() is called and the cursor moves into a new system outside of the current view frame. */
     followCursor?: boolean;
-    /** Broad Parameters like compact or preview mode. Also try "compacttight", which is like compact but also reduces margins. */
+    /** Broad Parameters like compact or preview mode.
+     * Also try "compacttight", which is like compact but also reduces margins.
+     * To see what this mode does and maybe adjust the spacing parameters yourself instead of using the mode,
+     * see DrawingParameters.ts:setForCompactTightMode().
+     */
     drawingParameters?: string | DrawingParametersEnum;
     /** Whether to draw credits (title, subtitle, composer, lyricist) (in future: copyright etc., see <credit>). */
     drawCredits?: boolean;