docs: fix board methods api and a note directive

machow · machow · commit 34cddc1d68fc · 2022-05-26T16:59:37.000-04:00
diff --git a/docs/api/boards.rst b/docs/api/boards.rst
@@ -1,7 +1,7 @@
 Board Methods
 =============
 
-.. currentmodule:: pins
+.. currentmodule:: pins.boards
 
 Constructor
 -----------
diff --git a/docs/getting_started.Rmd b/docs/getting_started.Rmd
@@ -88,11 +88,12 @@ That said, most boards transmit pins over HTTP, and this is going to be slow and
 As a general rule of thumb, we don't recommend using pins with files over 500 MB.
 If you find yourself routinely pinning data larger that this, you might need to reconsider your data engineering pipeline.
 
-
+<!-- #region -->
 ```{note}
 If you are using the RStudio Connect board (`board_rsconnect`), then you must specify your pin name as
 `<user_name>/<content_name>`. For example, `hadley/sales-report`.
 ```
+<!-- #endregion -->
 
 
 ## Metadata
