search

sestoft / C5

C5 generic collection library for C#/.NET
http://www.itu.dk/research/c5/
MIT License
1.03k stars 181 forks source link

Proposed documentation improvements #49

Closed kasajian closed 8 years ago

kasajian commented 8 years ago

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 commented 8 years ago

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.com<mailto: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/sestoft/C5/issues/49, or mute the threadhttps://github.com/notifications/unsubscribe/AAsoEDfQx1VVHTn-zzbaWkpmqtfPgd0mks5qKcpHgaJpZM4IzTbB.

kasajian commented 8 years ago

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 commented 8 years ago

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

kasajian commented 8 years ago

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 https://github.com/sestoft/C5/issues/49#issuecomment-226098694, or mute the thread https://github.com/notifications/unsubscribe/ACRjnYzllwBAnoR8sBcSexWElhhY90Lnks5qL5qIgaJpZM4IzTbB .