Skip to content

Commit

Permalink
doc: fix footnote markup
Browse files Browse the repository at this point in the history
  • Loading branch information
juba committed Apr 9, 2024
1 parent 8058804 commit 9389563
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/getting_started.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ iucn

## Initialize a `Lifemap` object

The next step is to create a new [Lifemap](`~pylifemap.Lifemap`) object. To do this we have to pass it our DataFrame, as well as the name of the column with our taxonomy identifiers[^if your column is named "taxid" you can omit the `taxid_col` argument as it is its default value.]:
The next step is to create a new [Lifemap](`~pylifemap.Lifemap`) object. To do this we have to pass it our DataFrame, as well as the name of the column with our taxonomy identifiers^[if your column is named "taxid" you can omit the `taxid_col` argument as it is its default value.]:

```{python}
from pylifemap import Lifemap
Expand Down Expand Up @@ -107,7 +107,7 @@ Lifemap(iucn, taxid_col="taxid").layer_points().show()
```

::: {.callout-note}
When in a notebook environment, calling [show()](`~pylifemap.Lifemap.show`) will display the visualisation as a widget. When called from a Python script or a textual Python REPL, the visualisation will be saved to a temporary file and, if possible, displayed in the user's browser.
When in a notebook environment, calling [show()](`~pylifemap.Lifemap.show`) will display the visualisation as a widget. When called from a Python script or a textual Python REPL, the visualization will be saved to a temporary file and, if possible, displayed in the user's browser. When called from a Python script running inside our Docker container, it will be saved to a file in the working directory.
:::

We can also save it to an HTML file which can be opened later in a browser by using the [save()](`~pylifemap.Lifemap.save`) method:
Expand Down

0 comments on commit 9389563

Please sign in to comment.