Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Website documentation fixes #33

Open
duffee opened this issue Nov 28, 2024 · 5 comments
Open

Website documentation fixes #33

duffee opened this issue Nov 28, 2024 · 5 comments
Assignees

Comments

@duffee
Copy link
Collaborator

duffee commented Nov 28, 2024

This is a checklist of problems in the documentation, meaning small fixes that we need to get around to applying. Add any speeling errors, broken links or things that just don't make sense and we'll fix them.

Fixes to the documentation needed:

  • the note about the implementing package being a C<> not a L<> (which wouldn't help anyway since there's no POD in there)
  • https://metacpan.org/pod/PDL::Graphics::TriD#points3d says "see module doc" but there isn't any
  • PDL::Graphics::TriD::Objects line 7 refers to TkTriD_demo.pm which doesn't exist
@duffee duffee self-assigned this Nov 28, 2024
@duffee
Copy link
Collaborator Author

duffee commented Dec 18, 2024

Improvements for the PDL book :

  • text needs proof-reading
  • Table of Contents indentation to reflect structure (can we put section numbers in the table?)
  • TODO's collected into a project so they can be systematically tackled
  • identify the missing chapters, which functions could do with some love
  • fix example script locations (404 for https://pdl.perl.org/content/book/PLplot/x08.pl)
  • check code still works as shown
  • look into transforming source into Jupyter Notebooks and epub (requirement - code must look good on my Nook)

Resources to consider

  • HeVeA is used by Allen Downey to do LaTeX to html translation

@duffee
Copy link
Collaborator Author

duffee commented Jan 15, 2025

@duffee
Copy link
Collaborator Author

duffee commented Jan 23, 2025

Tracking minor module perldoc corrections needed:

  • PDL::Dataflow ONE-WAY This means PDL will only created directed to create

@mohawk2
Copy link
Member

mohawk2 commented Jan 23, 2025

Tracking minor module perldoc corrections needed:

  • PDL::Dataflow ONE-WAY This means PDL will only created directed to create

Is it not easier to just PR corrections, rather than carefully track them on a separate repo issue?

@duffee
Copy link
Collaborator Author

duffee commented Jan 23, 2025

Is it not easier to just PR corrections, rather than carefully track them on a separate repo issue?

A PR will take me out of the headspace where I'm reading the docs. Editing an Issue requires no thought, but means I'll get to it at some point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants