Sounds reasonable.
Question: Why are there
mapped_wiki_inline_code['Pointer_stringify()']=':js:func:`Pointer_stringify`'
's in a python file there?
- Alon
On Mon, Jul 21, 2014 at 5:03 PM, Hamish Willee <[email protected]>
wrote:
> Thanks for the feedback - I've fixed the two cases.
>
> >I think we should start to merge this in, that is, make a pull request
> that imports this in place of the current docs. Then changes can be just
> normal pull requests on the repo. Also, the sooner we merge the better as
> the relevant files do get changed all the time.
>
> Sounds good. I think the pre-condition should be that we are also
> *publishing* the snapshot of the documents on github pages (and map to
> emscripten.org).
> My thought is that I'd spend some time on the home page entry point this
> week to get it to a minimal standard - still pointing to the wiki for most
> documents.
>
> FYI Currently I'm building this on an Emscripten fork on my repo here
> <https://github.com/hamishwillee/emscripten/tree/master/site>, with the
> api reference docs here
> <https://github.com/hamishwillee/emscripten/tree/master/site/source/docs/docs/api-reference>
> .
>
>
>
> On Tue, Jul 22, 2014 at 9:36 AM, Alon Zakai <[email protected]> wrote:
>
>> Nice work. I think we should start to merge this in, that is, make a pull
>> request that imports this in place of the current docs. Then changes can be
>> just normal pull requests on the repo. Also, the sooner we merge the better
>> as the relevant files do get changed all the time.
>>
>> Some notes:
>>
>> 1. The EMSCRIPTEN_KEEPALIVE section has an example. Should it say "For
>> example" or such before it, perhaps?
>>
>> 2. "Emits debugger" this should say "Emits <code>debugger;</code>", as
>> that is a code fragment.
>>
>> - Alon
>>
>>
>>
>> On Sun, Jul 20, 2014 at 8:09 PM, Hamish Willee <[email protected]>
>> wrote:
>>
>>> Hi All
>>>
>>> The public API for Emscripten is now documented, and ready for review - see
>>> it here
>>> <https://dl.dropboxusercontent.com/u/3067678/emscripten-site/docs/docs/api-reference/index.html>
>>> .
>>>
>>> Please review emscripten.h, preamble.js, html5.h and the "Advanced" APIs
>>> document. Note that the API currently reflects incoming branch, so html5.h
>>> uses typdef'd function pointer callbacks rather than having these in the
>>> registration function.
>>>
>>> Feel free to email me directly with responses.
>>>
>>> What I'm looking for:
>>> - Descriptions that are unclear
>>> - Typographic errors
>>> - Structure that doesn't "make sense"
>>> - Missing APIs - APIs that should be public but aren't documented, or
>>> internal APIs that might reasonably be mistaken as public and should appear
>>> in the "advanced/internal API document.
>>> - Missing exceptions - unexpected fail cases
>>> - APIs that really need an code fragment as part of their API reference
>>> description (please provide if you have one)
>>>
>>> Another nice feature of this release is that the wiki snapshot now fixes
>>> links to the other wiki snapshot articles, and all wiki "inline code
>>> markup" which corresponds to a public API item is now linked to those API
>>> items. The makes the wiki snapshot very much more usable and searchable
>>> than the "real" wiki.
>>>
>>> Your review thoughts appreciated.
>>>
>>> Regards
>>> Hamish
>>>
>>> On Tuesday, 15 July 2014 16:53:41 UTC+10, Hamish Willee wrote:
>>> Hi All
>>>
>>> emscripten.h documentation is ready for review:
>>> https://dl.dropboxusercontent.com/u/3067678/emscripten-site/docs/docs/api-reference/emscripten.h.html
>>>
>>> This is a manually created document. It includes changes to the function
>>> prototypes currently in incoming branch to make the function signatures
>>> simpler.
>>>
>>> I'm not completely convinced about the docs for
>>> emscripten_get_preloaded_image_data and there will need to be additional
>>> links to documents about EXPORTED_FUNCTIONS and other guide material when
>>> it exists.
>>>
>>> All feedback welcomed! For example, you might reasonably feel that the
>>> functions are the most important information in any section, and hence
>>> typedefs and defines should be defined after these.
>>>
>>> Regards
>>> H
>>>
>>>
>>>> --
>>> You received this message because you are subscribed to the Google
>>> Groups "emscripten-discuss" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an email to [email protected].
>>>
>>> For more options, visit https://groups.google.com/d/optout.
>>>
>>
>> --
>> You received this message because you are subscribed to a topic in the
>> Google Groups "emscripten-discuss" group.
>> To unsubscribe from this topic, visit
>> https://groups.google.com/d/topic/emscripten-discuss/blW_cmBHd3s/unsubscribe
>> .
>> To unsubscribe from this group and all its topics, send an email to
>> [email protected].
>>
>> For more options, visit https://groups.google.com/d/optout.
>>
>
> --
> You received this message because you are subscribed to the Google Groups
> "emscripten-discuss" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> For more options, visit https://groups.google.com/d/optout.
>
--
You received this message because you are subscribed to the Google Groups
"emscripten-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
