More stuff for the DeveloperGuide, as suggested in GitHub#481 #486
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
mohawk2
requested changes
Jun 29, 2024
mohawk2
force-pushed
the
master
branch
2 times, most recently
from
58f77dd
to
7748dcf
Compare
adjusted after review: * Basic/Pod/DeveloperGuide.pod: Delete the sections "Access to PDL's configuration" and "Ingesting an external PDL module". Document $::PP_VERBOSE and $PDL::Graphics::TriD::verbose. Add a section "Generating a Stack Trace" taken from GitHub issue PDLPorters#393. Add some more mappings to the package->source file table. * Basic/PDL.pm: Link to the Developer Guide under LANGUAGE DOCUMENTATION. * Basic/Pod/FAQ.pod: Link to the Developer Guide in Q: 3.5. * Basic/Pod/QuickStart.pod: Link to the Developer Guide. Also remove a phrase "until recently" which was recent ... in 1998, and don't mention HTML copies of the documentation which are no longer generated (and https://perldoc.perl.org exists). Changes according to mohawk2's review: * Mention $PDL::verbose and PDL::debug. * Adapt the section to organize commit to current best practice "one commit per small, meaningfil change" * Delete modules outside the repository from the module->file table * Add a line describing pdldoc
HaraldJoerg
force-pushed
the
devdoc_june
branch
from
bcb9951
to
3f5788e
Compare
|
Thank you! Are you happy for me to merge this, or is there more you'd like to change? |
|
Thank you! |
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.
Basic/Pod/DeveloperGuide.pod: Delete the sections "Access to PDL's configuration" and "Ingesting an external PDL module". Document $::PP_VERBOSE and $PDL::Graphics::TriD::verbose. Add a section "Generating a Stack Trace" taken from GitHub issue better document debug macros #393. Add some more mappings to the package->source file table.
Basic/PDL.pm: Link to the Developer Guide under LANGUAGE DOCUMENTATION.
Basic/Pod/FAQ.pod: Link to the Developer Guide in Q: 3.5.
Basic/Pod/QuickStart.pod: Link to the Developer Guide. Also remove a phrase "until recently" which was recent ... in 1998, and don't mention HTML copies of the documentation which are no longer generated (and https://perldoc.perl.org exists).