Euphoria
Ticket #481:
Bad Signature in Docs
-
Reported by
mattlewis
Dec 03, 2010
At time of writing, here:
http://openeuphoria.org/docs/std_sequence.html#_2685_badsigeucode
I'm not sure what this was, or if it's a bug in eudoc or creole or what. Based on the text, I guess it's the documentation for an enum used with stdseq:remove_dups().
9.4.6.15 BadSig:
include std/sequence.e
public enum
These are used with the remove_dups() function.
RD_INPLACE removes items while preserving the original order of the unique items.
RD_PRESORTED assumes that the elements in source_data are already sorted.
If they are not already sorted, this option merely removed adjacent duplicate elements.
RD_SORT will return the unique elements in ascending sorted order.
Details
1. Comment by jeremy
Dec 03, 2010
All documented individually now.
2. Comment by ne1uno
Dec 03, 2010
there were a few more BadSig in
- std/map.e
- std/types.e
- std/stack.e
fixed next time the docs are generated & updated.
BadSig is a message from eudoc about confusing markup. common mistake is to use start document next item --** where eudoc will assume the next global, public, export or override is the target when you really intend start description --****
another is to start document next item, a routine, variable or constant then insert some top level code or blank lines and more comments between the markup and the intended item.
3. Comment by jeremy
Dec 03, 2010
New manual has been uploaded.