Provide more useful link in man page#401
Merged
marc-vanderwal merged 3 commits intozonemaster:developfrom Dec 3, 2024
Merged
Conversation
The “SEE ALSO” section in the man page had a POD link to a Perl package called Zonemaster. But no such package actually exists; also, it looks very awkward when reading the man page version of that documentation. This commit removes the link that had no chance to work, and replaces it with something more useful. As a drive-by change, remove some contractions, as they are usually frowned upon in written text, unless it is informal.
marc-vanderwal
requested review from
MichaelTimbert,
matsduf,
mattias-p and
tgreenx
Contributor
I am for that. |
matsduf
previously approved these changes
Dec 2, 2024
tgreenx
reviewed
Dec 2, 2024
There were a few more instances of L<Zonemaster> links to be removed. Once again, they have no chance to work, because no package named Zonemaster exists on CPAN; only packages for individual Zonemaster components exist there.
Typo fixed courtesy of @tgreenx. By additional careful proofreading and running flyspell in Emacs, there are no other such typos in the documentation.
matsduf
approved these changes
Dec 3, 2024
tgreenx
approved these changes
Dec 3, 2024
Contributor
|
@marc-vanderwal, please merge. |
matsduf
added
the
V-Patch
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
3 participants
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.
Purpose
This PR replaces the text in the “See also” section of the man page/POD documentation in the
zonemaster-clicommand line utility with some information that I deemed more useful.The previous text had a link to a Perl package called Zonemaster. But no such package actually exists, so the link is broken. Also, it looks very awkward when reading the man page version of this documentation, because links like these cannot be clicked on and just appear as “Zonemaster”. So the whole section reads as “See also: Zonemaster” in the man page.
Context
Release testing for 2024.2; PR #389.
Changes
How to test this PR
Run
perldoc -o man script/zonemaster-clifrom the root of the code repository and check for correct rendering of the “See also” section.