Skip to content

improve releases links and vessel include documentation#58

Open
lykmapipo wants to merge 5 commits intofeature/additional-insightsfrom
feature/docs
Open

improve releases links and vessel include documentation#58
lykmapipo wants to merge 5 commits intofeature/additional-insightsfrom
feature/docs

Conversation

@lykmapipo
Copy link
Copy Markdown
Collaborator

This:

  • Add direct links to GitHub Releases and PyPI package on the documentation homepage
  • Clarify behavior of POTENTIAL_RELATED_SELF_REPORTED_INFO vessel include option
  • Expand vessel include docstrings with additional usage context and references
  • Align VesselResource parameter documentation with updated include descriptions

This:
- add direct link to GitHub Releases page
- add direct link to published package on PyPI
…ehavior

This:
- expand `VesselInclude.POTENTIAL_RELATED_SELF_REPORTED_INFO` docstring
- add official Vessel Viewer reference link for context and usage understanding
- align `VesselResource` parameter documentation with updated include description
@lykmapipo lykmapipo self-assigned this Mar 31, 2026
@lykmapipo lykmapipo added the documentation Improvements or additions to documentation label Mar 31, 2026
Copy link
Copy Markdown
Collaborator

@giselamo giselamo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a small comment

Identity information derived from public registries.

See how the Vessel API is used in the Vessel Viewer
here: https://globalfishingwatch.org/our-apis/assets/2024_Vessel_Viewer_and_APIs_behind_It.pdf
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please also add "Also check here for data caveats about vessel identity"


See how the Vessel API is used in the Vessel Viewer
here: https://globalfishingwatch.org/our-apis/assets/2024_Vessel_Viewer_and_APIs_behind_It.pdf

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please also add "Also check here for data caveats about vessel identity"


See how the Vessel API is used in the Vessel Viewer
here: https://globalfishingwatch.org/our-apis/assets/2024_Vessel_Viewer_and_APIs_behind_It.pdf

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please also add "Also check here for data caveats about vessel identity"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants