[swift-dev] Documentation

Ted kremenek kremenek at apple.com
Wed Jan 6 16:22:33 CST 2016


Hi James,

We're interested in hosting documentation on Swift.org for a variety of reasons.  One motivating reason is to showcase the documentation for the version of the Standard Library that is in active development on 'master'.  For example, whenever we generate a new snapshot that can be downloaded we update posted documentation.

We're exploring various options.  If you have specific suggestions on what you would like to see, please speak up.

Thanks,
Ted

> On Jan 6, 2016, at 11:06 AM, James Campbell via swift-dev <swift-dev at swift.org> wrote:
> 
> Is there a way of improving the documentation and hosting it on Swift instead of Apple ?
> 
> Currently the Array page lists all of the things the class directly implements but doesn't include any of the methods mixed in by protocol extensions (i.e all of the methods from CollectionType).
> 
> With YardDoc for Ruby it does this, so you know exactly what methods a class has.
> 
> This confused me to no end as some topics here suggest adding ways of dropping the first X elements and even I have implemented `shift` which I didn't know already exist albeit under another name.
> 
> Would be great if we could improve these documents for the language in an open source way :)
> 
> -- 
>  Wizard
> james at supmenow.com
> +44 7523 279 698
> 
> _______________________________________________
> swift-dev mailing list
> swift-dev at swift.org
> https://lists.swift.org/mailman/listinfo/swift-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.swift.org/pipermail/swift-dev/attachments/20160106/f4cf151b/attachment.html>


More information about the swift-dev mailing list