documentation for configurable options

michaelb · Nov 7, 2021 · 7425186 · 7425186
1 parent c483ab7
commit 7425186
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## v1.0.3
+- configurable filetypes
+
 ## v1.0.2
 - fix issue with API functions & callbacks
 - fix double checkhealt crash issue

diff --git a/CHECKLIST.md b/CHECKLIST.md
@@ -2,6 +2,7 @@
 
  - check compilation success
  - update Cargo.lock: `cargo update`
+ - Bump Cargo.toml to next version
  - cargo fmt --all / cargo check / cargo clippy
  - create a version bump commit
  - merge
@@ -12,4 +13,3 @@
 
  - Check CI status
  - Check Releases status
- - Bump Cargo.toml to next version
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sniprun"
-version = "1.0.2"
+version = "1.0.3"
 authors = ["michaelb <[email protected]>"]
 edition = "2018"
 

diff --git a/README.md b/README.md
@@ -274,7 +274,12 @@ require'sniprun'.setup({
   repl_enable = {},               --# enable REPL-like behavior for the given interpreters
   repl_disable = {},              --# disable REPL-like behavior for the given interpreters
 
-  interpreter_options = {},       --# intepreter-specific options, consult docs / :SnipInfo <name>
+  interpreter_options = {         --# intepreter-specific options, see docs / :SnipInfo <name>
+    GFM_original = {
+      use_on_filetypes = {"markdown.pandoc"}    --# the 'use_on_filetypes' configuration key is
+                                                --# available for every interpreter
+    }
+  },      
 
   --# you can combo different display modes as desired
   display = {
@@ -317,7 +322,7 @@ EOF
 Example, to use the interpreter 'Python3\_jupyter' whenever possible [instead of the 'Python3\_original' default],
 `lua require'sniprun'.setup({selected_interpreters = {'Python3_jupyter'}})`
 
-**NOTE**: Some interpreters have specific options and dependencies, such as what version / compiler to use: you cand find more about that with `:SnipInfo <interpreter_name>`
+**NOTE**: Some interpreters have specific options and dependencies, such as what version / compiler to use: you cand find more about that with `:SnipInfo <interpreter_name>`. The `use_on_filetypes` key is available for every interpreter (as an `interpreter_option`) and allow sniprun to understand that your particular/custom filetypes are compatible with an interpreter.