doc: Use intra-doc-links instead of relative paths to html pages #1084
Conversation
This file contains 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
MarijnS95
force-pushed
the
intra-instead-of-file-link
branch
from
d135fed
to
9f6d507
Compare
|
@sophie-h Rebased and conflict automatically resolved (first commit was already applied), please review on gtk-rs :) |
|
I try. Great chance to understand the separated lgpl-docs. |
sophie-h
suggested changes
Apr 10, 2021
MarijnS95
force-pushed
the
intra-instead-of-file-link
branch
from
9f6d507
to
cb6d54f
Compare
sophie-h
approved these changes
Apr 11, 2021
MarijnS95
force-pushed
the
intra-instead-of-file-link
branch
from
cb6d54f
to
a3fe920
Compare
Using intra-doc-links saves quite a bit of code in gir, looks cleaner in the markdown files and resulting docs (`[src]` button mostly), and has the advantage of being checked by `rustdoc` for validity. That last point is not totally fair as most of these trait "implements" / "implementors" segments are generated inside macros, for which `rustdoc` does not seem to emit any warnings or errors currently.
MarijnS95
force-pushed
the
intra-instead-of-file-link
branch
from
a3fe920
to
70c312b
Compare
|
This supposedly also fixes broken links in CC @bilelmoussaoui :) |
sdroege
approved these changes
Apr 18, 2021
bilelmoussaoui
approved these changes
Apr 18, 2021
GuillaumeGomez
approved these changes
Apr 18, 2021
|
Nice, thanks! |
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.
Using intra-doc-links saves quite a bit of code in gir, looks cleaner in the markdown files and resulting docs (
[src]button mostly), and has the advantage of being checked byrustdocfor validity.That last point is not totally fair as most of these trait "implements" / "implementors" segments are generated inside macros, for which
rustdocdoes not seem to emit any warnings or errors currently.This has only been tested on GStreamer-rs, and only sampled at random because of aforementioned "no-warnings-in-macros" issue 😞