search

greghendershott / aws

Racket support for Amazon Web Services.
BSD 2-Clause "Simplified" License
78 stars 26 forks source link

`sign-uri` not documented? #69

Closed mflatt closed 1 year ago

mflatt commented 1 year ago

When rendering, I get

raco setup: WARNING: undefined tag in <pkgs>/aws/aws/aws.scrbl:
raco setup:  ((lib "aws/s3.rkt") sign-uri)

It seems that ddeee9c2152f6aabaa55753fe8f4872088db060d added a reference to that name in the documentation.

Also, I was puzzled about the example that the documentation change referred to until I looked at the commit. Maybe the new example was supposed to be in the documentation, or maybe the documentation was meant to refer to the "examples" directory.

greghendershott commented 1 year ago

Sorry for the confusion; I guess I merged #68 too casually.

I thought the contributor meant for people to look at examples.rkt, which seemed acceptable-ish, but I didn't realize the undefined tag warning.

A minimal fix: change that @racket to a @hyperlink to the file, e.g. pointing here on github.

Better/ideally: move the contents of examples.rkt into the docs proper.

I'll one of those two things...