Skip to content

Commit

Permalink
docs: minor corrections (#122)
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli authored Oct 9, 2023
1 parent 2f4cdf2 commit 48dda25
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/md/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ print([asset["name"] for asset in assets])

This yields `['code.json', 'linux.zip', 'mac.zip', 'win64.zip']`.

Equivalently, using the `list_release_assets()` function to list the latest release assets directly:
Equivalently, using the `get_release_assets()` function to list the latest release assets directly:

```python
from modflow_devtools.download import get_release_assets
Expand Down
4 changes: 2 additions & 2 deletions docs/md/ostags.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ The second argument specifies the mapping in format `<source>2<target>`, where `

## Getting suffixes

A convenience function is available to get the appropriate binary file extensions for a given operating system, identified by tag (or the current operating system if no tag is provided). The return value is a 2-tuple containing the executable and library extensions, respectively.
A convenience function is available to get the appropriate binary file extensions for a given operating system, identified by any supported OS tag, or the current operating system if no tag is provided. The return value is a 2-tuple containing the executable and library extensions, respectively.

```python
get_binary_suffixes() # get extensions for current OS
get_binary_suffixes("linux") # returns ("", ".so")
get_binary_suffixes("linux") # returns ("", ".so")
get_binary_suffixes("mac") # returns ("", ".dylib")
get_binary_suffixes("win64") # returns (".exe", ".dll")
```

0 comments on commit 48dda25

Please sign in to comment.