racket / racket/scribble

Package catalog links?

Open
#135 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Racket
Stars
250
Forks
102
Avg merge
11d 11h
Merged PRs (30d)
1

Description

In the block that defmodule outputs:
screen shot 2017-08-27 at 12 57 04 am
... it would be nice if the package: mock text was also a hyperlink to the mock package catalog entry (https://pkgd.racket-lang.org/pkgn/package/mock). I'm not sure how to implement this when different packages on the same system are installed from catalogs other than pkgd.racket-lang.org, or what to do for packages that aren't installed from a catalog at all.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the block that defmodule outputs and trace how the package: mock text is generated. Determine how installed packages identify their catalog source, including packages without a catalog, then make the package name link to the appropriate catalog entry where possible and verify the output for each case.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.