Updated species list documentation#901
Merged
Josef-Haupt merged 4 commits intoMay 4, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates BirdNET Analyzer’s CLI documentation/help text around species list generation, clarifying coordinate units and when week-based filtering applies.
Changes:
- Clarify
--lat/--lonas decimal degrees in docstrings and argparse help. - Add/expand guidance that
--weekis only relevant when using location-based filtering (lat/lon), and describe interaction with--slist.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+163
to
+172
| p.add_argument( | ||
| "--lat", | ||
| type=float, | ||
| help="Recording location latitude in decimal degrees. Cannot be used together with --slist, use either the species list or the location coordinates", | ||
| ) | ||
| p.add_argument( | ||
| "--lon", | ||
| type=float, | ||
| help="Recording location longitude in decimal degrees. Cannot be used together with --slist, use either the species list or the location coordinates", | ||
| ) |
Comment on lines
154
to
159
| --week (int): Week of the year when the recording was made. Values in [1, 48] (4 weeks per month). | ||
| Set -1 for year-round species list. Default is -1. | ||
| Only effective when --lat and --lon are provided; ignored when a species list (--slist) is given. | ||
| Leave blank for year-round species list. | ||
| --slist (str): Path to species list file or folder. If folder is provided, species list needs to be named | ||
| "species_list.txt". If lat and lon are provided, this list will be ignored. | ||
| --sf_thresh (float): Minimum species occurrence frequency threshold for location filter. Values in [0.01, 0.99]. |
| Leave blank for year-round species list. | ||
| --slist (str): Path to species list file or folder. If folder is provided, species list needs to be named | ||
| "species_list.txt". If lat and lon are provided, this list will be ignored. | ||
| --sf_thresh (float): Minimum species occurrence frequency threshold for location filter. Values in [0.01, 0.99]. |
| Set -1 for year-round species list. Default is -1. | ||
| Only effective when --lat and --lon are provided; ignored when a species list (--slist) is given. | ||
| Leave blank for year-round species list. | ||
| --sf_thresh (float): Minimum species occurrence frequency threshold for location filter. Values in [0.01, 0.99]. |
Josef-Haupt
deleted the
882-documentation-how-is-the-week-parameter-used-when-a-species-list-is-given
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.