From f353f105973d0e0eb54f4e2defcf98afca461e09 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Georges=20Dup=C3=A9ron?= <georges.duperon@gmail.com>
Date: Tue, 27 Dec 2016 19:18:54 +0100
Subject: [PATCH] Fixed rendering issues with Scribble

---
 ...th-utils.rkt => flexible-with-utils.hl.rkt | 30 ++++++++++++++++++-
 flexible-with.rkt => flexible-with.hl.rkt     | 18 +++++++++--
 scribblings/phc-graph-implementation.scrbl    |  3 +-
 3 files changed, 47 insertions(+), 4 deletions(-)
 rename flexible-with-utils.rkt => flexible-with-utils.hl.rkt (77%)
 rename flexible-with.rkt => flexible-with.hl.rkt (94%)

diff --git a/flexible-with-utils.rkt b/flexible-with-utils.hl.rkt
similarity index 77%
rename from flexible-with-utils.rkt
rename to flexible-with-utils.hl.rkt
index 3da7c0e..b71232f 100644
--- a/flexible-with-utils.rkt
+++ b/flexible-with-utils.hl.rkt
@@ -1,5 +1,19 @@
 #lang aful/unhygienic hyper-literate type-expander/lang
 
+@(require scribble-math)
+
+@title[#:style manual-doc-style]{Flexible functional modification and
+ extension of records (utility functions)}
+
+@(chunks-toc-prefix
+  '("(lib phc-graph/scribblings/phc-graph-implementation.scrbl)"
+    "phc-graph/flexible-with"))
+
+@defmodule[(lib "phc-graph/flexible-with-utils.hl.rkt")]
+
+@(unless-preexpanding
+  (require (for-label (submod ".."))))
+
 @chunk[<*>
        (require (for-syntax racket/base))
        
@@ -19,6 +33,8 @@
          <test-to-bits>
          <test-from-bits>)]
 
+@defproc[(to-bits [n exact-nonnegative-integer?]) (listof boolean?)]{}
+
 @CHUNK[<to-bits>
        ;     1      =>                     1
        ;  2     3   =>          10                  11
@@ -57,6 +73,8 @@
        (check-equal? (to-bits 12) '(#t #t #f #f))
        (check-equal? (to-bits 1024) '(#t #f #f #f #f #f #f #f #f #f #f))]
 
+@defproc[(from-bits [n (listof boolean?)]) exact-nonnegative-integer?]{}
+
 @CHUNK[<from-bits>
        (define-for-syntax (from-bits b)
          (foldl (λ (bᵢ acc)
@@ -77,12 +95,22 @@
        (check-equal? (from-bits '(#t #t #f #f)) 12)
        (check-equal? (from-bits '(#t #f #f #f #f #f #f #f #f #f #f)) 1024)]
 
+@defproc[(floor-log2 [n exact-positive-integer?])
+         exact-nonnegative-integer?]{
+ Exact computation of @${\lfloor\log_2(n)\rfloor}.
+}
+
 @chunk[<floor-log2>
        (define-for-syntax (floor-log2 n)
          (if (<= n 1)
              0
              (add1 (floor-log2 (quotient n 2)))))]
 
+@defproc[(ceiling-log2 [n exact-positive-integer?])
+         exact-nonnegative-integer?]{
+ Exact computation of @${\lceil\log_2(n)\rceil}.
+}
+
 @chunk[<ceiling-log2>
        (define-for-syntax (ceiling-log2 n)
-         (floor-log2 (sub1 (* n 2))))]
\ No newline at end of file
+         (floor-log2 (sub1 (* n 2))))]
diff --git a/flexible-with.rkt b/flexible-with.hl.rkt
similarity index 94%
rename from flexible-with.rkt
rename to flexible-with.hl.rkt
index 0393a54..c1b53dc 100644
--- a/flexible-with.rkt
+++ b/flexible-with.hl.rkt
@@ -1,5 +1,14 @@
 #lang aful/unhygienic hyper-literate type-expander/lang
 
+@title[#;#:style #;(with-html5 manual-doc-style)
+       #:tag "flexible-with"
+       #:tag-prefix "phc-graph/flexible-with"]{Flexible functional
+ modification and extension of records}
+
+@(chunks-toc-prefix
+  '("(lib phc-graph/scribblings/phc-graph-implementation.scrbl)"
+    "phc-graph/flexible-with"))
+
 @chunk[<*>
        (require (for-syntax (rename-in racket/base [... …])
                             syntax/stx
@@ -8,7 +17,7 @@
                             syntax/id-table
                             racket/sequence)
                 (for-meta 2 racket/base)
-                "flexible-with-utils.rkt")
+                "flexible-with-utils.hl.rkt")
        
        <tree-type-with-replacement>
        <define-replace-in-tree>
@@ -18,6 +27,9 @@
        <define-trees>
        <example>]
 
+@racketblock[
+ (a #,(+ 1 1) b)]
+
 @CHUNK[<tree-type-with-replacement>
        (define-for-syntax (tree-type-with-replacement n last τ*)
          (define-values (next mod) (quotient/remainder n 2))
@@ -221,4 +233,6 @@
            [sbc b c])
 
        (ann (with-c (sab→tree 1 2) 'nine)
-            ((bt-fields a b c) One Positive-Byte 'nine))]
\ No newline at end of file
+            ((bt-fields a b c) One Positive-Byte 'nine))]
+
+@include-section[(submod "flexible-with-utils.hl.rkt" doc)]
\ No newline at end of file
diff --git a/scribblings/phc-graph-implementation.scrbl b/scribblings/phc-graph-implementation.scrbl
index dcaa5ed..5a4a309 100644
--- a/scribblings/phc-graph-implementation.scrbl
+++ b/scribblings/phc-graph-implementation.scrbl
@@ -11,4 +11,5 @@ the @other-doc['(lib "phc-graph/scribblings/phc-graph.scrbl")] document.
 
 @(table-of-contents)
 
-@include-section[(submod "../traversal.hl.rkt" doc)]
\ No newline at end of file
+@include-section[(submod "../traversal.hl.rkt" doc)]
+@include-section[(submod "../flexible-with.hl.rkt" doc)]
\ No newline at end of file