style: fix too-long doc lines - Githubissues

virtool / virtool

Viral infection diagnostics using next-generation sequencing

https://www.virtool.ca

MIT License

43 stars 24 forks source link

style: fix too-long doc lines #3063

Closed igboyes closed 1 month ago

igboyes commented 1 month ago

Changes

Fix doc lines that exceed 90 character limit.

Compatibility

We need to be very careful to identify breaking changes in.

Sources of breaking changes:

API

Removing a field from a response from an API endpoint.
Changing the shape of a response from an API endpoint.
Changing paths or search query parameters.
Removing deprecated functionality.
[x] Any changes I have made to the API are backwards compatible.

Migration

Making changes that require a certain migration to have been applied.
[x] My changes do not require a newer migration than the currently required migration..

Configuration

Changing configuration options that could break configurations in production and development environments.
[x] My changes do not change configuration value names or types.

Services

Making changes that require a certain version of a service like Postgres, Redis, or OpenFGA.
[x] My changes don't impose any new service requirements.

Notes

If you have introduced breaking changes, explain here.

Pre-Review Checklist

[x] All changes are tested.
[x] All touched code documentation is updated.
[x] Deepsource issues have been reviewed and addressed.
[x] Comments and print statements have been removed.

virtool-bot commented 1 month ago

:tada: This PR is included in version 25.0.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: