Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposed documentation improvements #49

Closed
kasajian opened this issue Jun 10, 2016 · 4 comments
Closed

Proposed documentation improvements #49

kasajian opened this issue Jun 10, 2016 · 4 comments
Labels
enhancement New feature or request

Comments

@kasajian
Copy link

I don't want to sound like I'm looking a gift-horse in the mouth, after all entire library is being given to us for free, but I have to say that I'm disappointed in the fact that the time-space complexity of the data structures is not documented. To me, that would be the first thing someone will look at. Like, if I look at, for instance, a hashed linked lists, it would be nice if it said what the cost is for look ups, insertion, etc. That's one of the main criterion for selecting a data-structure.

@sestoft
Copy link
Owner

sestoft commented Jun 10, 2016

Is it possible you missed the documentation:
http://www.itu.dk/research/c5/latest/ITU-TR-2006-76.pdf

Peter

On 10Jun16 22:34, "Kenneth Kasajian" <notifications@github.commailto:notifications@github.com> wrote:

I don't want to sound like I'm looking a gift-horse in the mouth, after all entire library is being given to us for free, but I have to say that I'm disappointed in the fact that the time-space complexity of the data structures is not documented. To me, that would be the first thing someone will look at. Like, if I look at, for instance, a hashed linked lists, it would be nice if it said what the cost is for look ups, insertion, etc. That's one of the main criterion for selecting a data-structure.

You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHubhttps://github.com//issues/49, or mute the threadhttps://github.com/notifications/unsubscribe/AAsoEDfQx1VVHTn-zzbaWkpmqtfPgd0mks5qKcpHgaJpZM4IzTbB.

@kasajian
Copy link
Author

Yes. I did miss it, and here's why. I'm looking at the front page of the project under "Getting Started". The second item is "documentation" and it points to https://c5docs.azurewebsites.net/

That documentation is nothing like the documentation that you pointed to, the PDF.

I am not sure if the PDF file you pointed to is also linked somewhere on here -- it may be staring in my face. But to be honest, when there's a section titled "documentation" in the readme, and it points to a link.. I wouldn't think "oh, there must be different documentation somewhere else", and go looking. I assumed that link is to the only docs that are available.

It makes perfect sense now that you pointed it out to me. Thank you for your help

@sestoft
Copy link
Owner

sestoft commented Jun 15, 2016 via email

@kasajian
Copy link
Author

word

On Tue, Jun 14, 2016 at 11:24 PM, Peter Sestoft notifications@github.com
wrote:

On 11Jun16 6:27, "Kenneth Kasajian" <notifications@github.com<mailto:
notifications@github.com>> wrote:

Yes. I did miss it, and here's why. I'm looking at the front page of the
project under "Getting Started". The second item is "documentation" and it
points to https://c5docs.azurewebsites.net/

Sorry about this silliness; I've now added a reference to the PDF
documentation too.

Peter


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#49 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/ACRjnYzllwBAnoR8sBcSexWElhhY90Lnks5qL5qIgaJpZM4IzTbB
.

@ondfisk ondfisk closed this as completed Aug 1, 2016
@JnxF JnxF added the enhancement New feature or request label Mar 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants