Re: [racket-users] Scribbling documentation for a module beginning with _

[Matthias Felleisen]

Serves you well for writing Python names with Racket tools :-) 


> On Apr 14, 2017, at 4:50 PM, 'John Clements' via Racket Users 
>  wrote:
> 
> 
>> On Apr 14, 2017, at 6:05 AM, Matthew Flatt  wrote:
>> 
>> I don't didn't find any other workaround.
>> 
>> I think it makes no sense to treat an `_` prefix specially in
>> `defmodule`, `racketmodlink`, etc. (and it wasn't really a good idea
>> for `racket`), so I've pushed a change to Scribble to disable `_`
>> treatment in those forms.
> 
> Wonderful! I’ve been trying to work around this in my class this quarter 
> where I’m trying to write down python names like @racket[__init__], and 
> having terrible trouble.
> 
> John
> 
> 
> 
> -- 
> You received this message because you are subscribed to the Google Groups 
> "Racket Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to racket-users+unsubscr...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [racket-users] Scribbling documentation for a module beginning with _

['John Clements' via Racket Users]

> On Apr 14, 2017, at 6:05 AM, Matthew Flatt  wrote:
> 
> I don't didn't find any other workaround.
> 
> I think it makes no sense to treat an `_` prefix specially in
> `defmodule`, `racketmodlink`, etc. (and it wasn't really a good idea
> for `racket`), so I've pushed a change to Scribble to disable `_`
> treatment in those forms.

Wonderful! I’ve been trying to work around this in my class this quarter where 
I’m trying to write down python names like @racket[__init__], and having 
terrible trouble.

John



-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [racket-users] Scribbling documentation for a module beginning with _

[Matthew Flatt]

I don't didn't find any other workaround.

I think it makes no sense to treat an `_` prefix specially in
`defmodule`, `racketmodlink`, etc. (and it wasn't really a good idea
for `racket`), so I've pushed a change to Scribble to disable `_`
treatment in those forms.

At Thu, 13 Apr 2017 21:11:57 -0400, Leif Andersen wrote:
> Oooh...that is an interesting case.
> 
> FWIW, you could always cheat, and have the docs use a different name
> for the module for defmodule's, and manually typeset the correct name
> out. Its kind of a kludge though:
> 
> ```
> @defmodule[@racketmodfont{_-exp}
>#:module-paths (secret_-exp)
>#:lang]
> 
> @racketmodlink[secret_-exp]{_-exp}
> ```
> 
> This also has the major downside that anyone else wanting to link to
> your module will have to know the `secret_-exp` name you chose. I
> guess that _could_ be worked around by making helper functions for
> them, but that seems kind of silly to me.
> 
> 
> ~Leif Andersen
> 
> 
> On Thu, Apr 13, 2017 at 8:44 PM, Philip McGrath
>  wrote:
> > I'm trying to write documentation for a module named _-exp, and I'm running
> > into a problem because (I think) of the way underscores are treated by
> > racketblock.
> >
> > Using @defmodule[_-exp #:lang] or @racketmodname[_-exp] typesets the name as
> > -exp .
> >
> > I can work around this for defmodule by doing
> >
> > @defmodule[@racketmodfont{_-exp}
> >#:module-paths (_-exp)
> >#:lang]
> >
> > but I haven't found a solution for linking to the definition. I'm currently
> > trying @racketmodlink[_-exp @racketmodfont["_-exp"]], but this causes raco
> > setup to complain:
> >
> > WARNING: undefined tag in /_-exp/scribblings/_-exp.scrbl:
> > raco setup:  (mod-path "_-exp")
> >
> > and indeed the link does not work.
> >
> > In my local documentation search results, _-exp  language shows up as
> > expected, so I think the problem is with the link, not the definition, but
> > I'm not sure how to fix this.
> >
> > Philip
> >
> > --
> > You received this message because you are subscribed to the Google Groups
> > "Racket Users" group.
> > To unsubscribe from this group and stop receiving emails from it, send an
> > email to racket-users+unsubscr...@googlegroups.com.
> > For more options, visit https://groups.google.com/d/optout.
> 
> -- 
> You received this message because you are subscribed to the Google Groups 
> "Racket Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to racket-users+unsubscr...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Re: [racket-users] Scribbling documentation for a module beginning with _

[Leif Andersen]

Oooh...that is an interesting case.

FWIW, you could always cheat, and have the docs use a different name
for the module for defmodule's, and manually typeset the correct name
out. Its kind of a kludge though:

```
@defmodule[@racketmodfont{_-exp}
   #:module-paths (secret_-exp)
   #:lang]

@racketmodlink[secret_-exp]{_-exp}
```

This also has the major downside that anyone else wanting to link to
your module will have to know the `secret_-exp` name you chose. I
guess that _could_ be worked around by making helper functions for
them, but that seems kind of silly to me.


~Leif Andersen


On Thu, Apr 13, 2017 at 8:44 PM, Philip McGrath
 wrote:
> I'm trying to write documentation for a module named _-exp, and I'm running
> into a problem because (I think) of the way underscores are treated by
> racketblock.
>
> Using @defmodule[_-exp #:lang] or @racketmodname[_-exp] typesets the name as
> -exp .
>
> I can work around this for defmodule by doing
>
> @defmodule[@racketmodfont{_-exp}
>#:module-paths (_-exp)
>#:lang]
>
> but I haven't found a solution for linking to the definition. I'm currently
> trying @racketmodlink[_-exp @racketmodfont["_-exp"]], but this causes raco
> setup to complain:
>
> WARNING: undefined tag in /_-exp/scribblings/_-exp.scrbl:
> raco setup:  (mod-path "_-exp")
>
> and indeed the link does not work.
>
> In my local documentation search results, _-exp  language shows up as
> expected, so I think the problem is with the link, not the definition, but
> I'm not sure how to fix this.
>
> Philip
>
> --
> You received this message because you are subscribed to the Google Groups
> "Racket Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to racket-users+unsubscr...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[racket-users] Scribbling documentation for a module beginning with _

[Philip McGrath]

I'm trying to write documentation for a module named _-exp, and I'm running
into a problem because (I think) of the way underscores are treated by
racketblock

.

Using @defmodule[_-exp #:lang] or @racketmodname[_-exp] typesets the name
as *-exp .*

I can work around this for defmodule by doing

@defmodule[@racketmodfont{_-exp}
   #:module-paths (_-exp)
   #:lang]

but I haven't found a solution for linking to the definition. I'm currently
trying @racketmodlink[_-exp @racketmodfont["_-exp"]], but this causes raco
setup to complain:

WARNING: undefined tag in /_-exp/scribblings/_-exp.scrbl:
raco setup:  (mod-path "_-exp")

and indeed the link does not work.

In my local documentation search results, _-exp  language shows up as
expected, so I think the problem is with the link, not the definition, but
I'm not sure how to fix this.

Philip

-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.