racket / racket/scribble

Handle JS errors when the package is still not uploaded to server

Open
#316 0 comments 0 reactions 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

When a package is still not uploaded to the package server, viewing the doc locally will attempt to query information from the package server, which of course will fail. However, it should not result in an unhandled error like:

GET https://pkgs.racket-lang.org/pkg/pprint-compact.json
[HTTP/3 404 Not Found 444ms]

and

Uncaught (in promise) SyntaxError: JSON.parse: unexpected character at line 1 column 1 of the JSON data

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

Reproduce local documentation viewing for a package that is not yet uploaded, then trace the package-server request that receives the 404 response and the subsequent JSON parsing. Done means the missing package does not produce an unhandled JavaScript error while viewing the documentation locally.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.