From 3c364bc7c363687e4e6b848e0f4b7ff8bf5557f0 Mon Sep 17 00:00:00 2001 From: Caglar Pir Date: Tue, 8 Sep 2026 10:26:27 +0200 Subject: [PATCH] Fix two broken documentation links Found by crawling every external URL in the built docs site and the repo; Docusaurus only validates internal links, so neither of these was caught by the build. 1. README license badge pointed at blob/master/LICENSE.txt -> 404. The default branch is main, and the file is LICENSE with no extension. Now blob/main/LICENSE (verified 200). 2. sylvana.net/jpegcrop/exif_orientation.html no longer resolves at all (connection failure, not a 404 - the host is gone). It is cited for the exif_orientation field in three source docstrings and the two generated docs pages built from them. Replaced with the Wayback snapshot, which preserves the original page rather than substituting a different source. The archive URL uses the /web/2026/ short form and sits on its own line in the Python docstrings, so no new E501 violations are introduced against the project's configured max-line-length of 100 (count stays at the pre-existing 1). The generated .md files are edited alongside the docstrings they come from, so the committed docs match until the next scripts/documentation.py run regenerates them. Not changed, having been checked and found to be false positives: - /stargazers returns 404 to unauthenticated clients for every repo, including facebook/react - GitHub blocks it, the link is fine - graph.mapillary.com/:image_id and similar are API endpoint examples containing placeholders, auto-linkified because they appear as bare URLs in docstrings - the 'Table Of Contents.md' edit link resolves once URL-encoded, which is how Docusaurus emits it --- README.md | 2 +- .../mapillary.config.api/mapillary.config.api.entities.md | 2 +- docs/docs/mapillary/mapillary.interface.md | 2 +- src/mapillary/config/api/entities.py | 6 ++++-- src/mapillary/interface.py | 3 ++- 5 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a140ebe..e8b5bf5 100644 --- a/README.md +++ b/README.md @@ -225,7 +225,7 @@ our [code of conduct](CODE_OF_CONDUCT.md). [issues-url]: https://github.com/mapillary/mapillary-python-sdk/issues -[license-url]: https://github.com/mapillary/mapillary-python-sdk/blob/master/LICENSE.txt +[license-url]: https://github.com/mapillary/mapillary-python-sdk/blob/main/LICENSE [linkedin-url]: https://www.linkedin.com/company/mapillary/ diff --git a/docs/docs/mapillary.config.api/mapillary.config.api.entities.md b/docs/docs/mapillary.config.api/mapillary.config.api.entities.md index afdd98b..0fe39d2 100644 --- a/docs/docs/mapillary.config.api/mapillary.config.api.entities.md +++ b/docs/docs/mapillary.config.api/mapillary.config.api.entities.md @@ -145,7 +145,7 @@ Fields: 10. computed_rotation - enum, corrected orientation of the image 11. creator - the username and user ID who owns and uploaded the image 12. exif_orientation - enum, orientation of the camera as given by the exif tag - (see: https://sylvana.net/jpegcrop/exif_orientation.html) + (see: https://web.archive.org/web/2026/https://sylvana.net/jpegcrop/exif_orientation.html) 13. geometry - GeoJSON Point geometry 14. height - int, height of the original image uploaded 15. make - string, the manufacturer name of the camera device diff --git a/docs/docs/mapillary/mapillary.interface.md b/docs/docs/mapillary/mapillary.interface.md index 7491fa3..b22b975 100644 --- a/docs/docs/mapillary/mapillary.interface.md +++ b/docs/docs/mapillary/mapillary.interface.md @@ -342,7 +342,7 @@ Gets an image for the given key argument 12. exif_orientation - enum, orientation of the camera as given by the exif tag - (see: [https://sylvana.net/jpegcrop/exif_orientation.html](https://sylvana.net/jpegcrop/exif_orientation.html)) + (see: [https://web.archive.org/web/2026/https://sylvana.net/jpegcrop/exif_orientation.html](https://web.archive.org/web/2026/https://sylvana.net/jpegcrop/exif_orientation.html)) 13. geometry - GeoJSON Point geometry diff --git a/src/mapillary/config/api/entities.py b/src/mapillary/config/api/entities.py index 3a317dd..560cef7 100644 --- a/src/mapillary/config/api/entities.py +++ b/src/mapillary/config/api/entities.py @@ -77,7 +77,8 @@ def get_image(image_id: str, fields: list) -> str: 10. computed_rotation - enum, corrected orientation of the image 11. creator - the username and user ID who owns and uploaded the image 12. exif_orientation - enum, orientation of the camera as given by the exif tag - (see: https://sylvana.net/jpegcrop/exif_orientation.html) + (see + https://web.archive.org/web/2026/https://sylvana.net/jpegcrop/exif_orientation.html) 13. geometry - GeoJSON Point geometry 14. height - int, height of the original image uploaded 15. make - string, the manufacturer name of the camera device @@ -133,7 +134,8 @@ def get_images( 10. computed_rotation - enum, corrected orientation of the image 11. creator - the username and user ID who owns and uploaded the image 12. exif_orientation - enum, orientation of the camera as given by the exif tag - (see: https://sylvana.net/jpegcrop/exif_orientation.html) + (see + https://web.archive.org/web/2026/https://sylvana.net/jpegcrop/exif_orientation.html) 13. geometry - GeoJSON Point geometry 14. height - int, height of the original image uploaded 15. make - string, the manufacturer name of the camera device diff --git a/src/mapillary/interface.py b/src/mapillary/interface.py index 9a74fa7..21dcd06 100644 --- a/src/mapillary/interface.py +++ b/src/mapillary/interface.py @@ -929,7 +929,8 @@ def image_from_key(key: str, fields: list = []) -> str: 10. computed_rotation - enum, corrected orientation of the image 11. creator - the username and user ID who owns and uploaded the image 12. exif_orientation - enum, orientation of the camera as given by the exif tag - (see: https://sylvana.net/jpegcrop/exif_orientation.html) + (see + https://web.archive.org/web/2026/https://sylvana.net/jpegcrop/exif_orientation.html) 13. geometry - GeoJSON Point geometry 14. height - int, height of the original image uploaded 15. make - string, the manufacturer name of the camera device