Skip to content

Commit 0c538bf

Browse files
committed
Fix module sources in docs
The original uses of defmodule were an attempt to clean up "undefined tag" warnings when building docs using `scribble +m` (i.e., outside `raco setup`). It turns out those warnings were a bug in scribble, hopefully fixed in racket/scribble@2e679f4. - Identifier tooltips in constructs.scrbl correctly name both splitflap/constructs and splitflap as source modules - Remove unnecessary #:use-sources
1 parent bc29f7f commit 0c538bf

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

splitflap-doc/constructs.scrbl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
@(define mod-constructs (make-base-eval #:lang 'racket/base))
2020
@(mod-constructs '(require splitflap gregor racket/file racket/promise))
2121

22-
@defmodule[splitflap/constructs]
22+
@declare-exporting[splitflap/constructs splitflap]
23+
@defmodule[splitflap/constructs #:no-declare]{
2324

2425
The format of feeds is specified by the @Atom1.0[] and @RSS2.0[] specifications (and, for all
2526
practical purposes, by @AppleRequirements[] in the case of podcasts). These in turn reference other
@@ -33,6 +34,8 @@ cases where it makes things simpler, Splitflap is a bit @emph{more} strict than
3334
The bindings documented in this section are provided by the main @racketmodname[splitflap] module
3435
as well as by @racketmodname[splitflap/constructs].
3536

37+
}
38+
3639
@section{Tag URIs}
3740

3841
Feeds, and items contained in feeds, require some globally unique identifier. Although any kind of

splitflap-doc/mod-splitflap.scrbl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@
1313
xml)
1414
(for-syntax racket/base racket/syntax))
1515

16-
@title[#:tag "mod-splitflapp"]{Library Reference}
16+
@title[#:tag "mod-splitflap"]{Library Reference}
17+
18+
@defmodule[splitflap]
19+
20+
This module also reprovides the bindings from @racketmodname[splitflap/constructs].
1721

1822
@(define mod-feed (make-base-eval #:lang 'racket/base))
1923
@(mod-feed '(require splitflap))

splitflap-doc/splitflap.scrbl

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
@flipboard-div
99
@flipboard-script
1010

11-
@defmodule[splitflap #:use-sources (splitflap/private/feed)]
12-
1311
This library provides a simple interface for building valid Atom and RSS feeds, including podcast
1412
feeds, for your web properties.
1513

0 commit comments

Comments
 (0)