]> code.delx.au - gnu-emacs-elpa/commitdiff
spinner: More doc
authorArtur Malabarba <bruce.connor.am@gmail.com>
Tue, 11 Aug 2015 10:30:49 +0000 (11:30 +0100)
committerArtur Malabarba <bruce.connor.am@gmail.com>
Tue, 11 Aug 2015 10:30:49 +0000 (11:30 +0100)
README.org

index 87fa1cb973689b0c64e1ffa2385a5bba5263cf46..4fb4a4ae430be1937f2177565b03301941ed9399 100644 (file)
@@ -67,3 +67,10 @@ third argument of the ~spinner-create~ function. The snippet below is an example
 
 This will use the ~moon~ spinner, but you can use any of the names
 defined in the ~spinner-types~ variable or even define your own.
+
+* Extra options
+
+Both ~spinner-start~ and ~spinner-create~ take extra options to configure the spinner, these are:
+
+- ~FPS~: The number of frames to display per second. Defaults to ~spinner-frames-per-second~.
+- ~DELAY~: After startin a spinner, it still won’t be displayed for this many seconds.