greycat icon indicating copy to clipboard operation
greycat copied to clipboard

Documentation is not in sync with code

Open tyoh opened this issue 7 years ago • 4 comments

Hi there.

Thank you for your amazing work! This looks really promising and I have been searching this kind of temporal graph database for long time!

I know the project is in early stage, but there is some mismatch on the documentation & code/sample.

For example, The documentation says there is "get" function available under "Task Actions", but is not on latest code. (documentation : http://greycat.ai/doc/tasks/actions/get.html)

It would be wonderful for especially early adapters if you put more latest working samples as the project evolves.

Thanks & enjoy your life!

Taeyang.

tyoh avatar Jan 03 '18 01:01 tyoh

Hi Taeyang,

Thanks a lot for your feedback!

We are currently working on a new release for the open source version and also of an extended commercial enterprise version of GreyCat. In this context we will also update/extend the documentation and the code snippets and make sure that they are align...

We hope to have this ready soon!

All the best, The GreyCat team

On 3 Jan 2018, at 02:15, Taeyang Oh [email protected] wrote:

Hi there.

Thank you for your amazing work! This looks really promising and I have been searching this kind of temporal graph database for long time!

I know the project is in early stage, but there is some mismatch on the documentation & code/sample.

For example, The documentation says there is "get" function available under "Task Actions", but is not on latest code. (documentation : http://greycat.ai/doc/tasks/actions/get.html http://greycat.ai/doc/tasks/actions/get.html)

It would be wonderful for especially early adapters if you put more latest working samples as the project evolves.

Thanks & enjoy your life!

Taeyang.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/datathings/greycat/issues/82, or mute the thread https://github.com/notifications/unsubscribe-auth/AE7tESdvUW0KULfZ-EFUCXgCXHWMluFqks5tGtSXgaJpZM4RRQcY.

thomashartmann avatar Jan 08 '18 15:01 thomashartmann

Hi,

The same when trying to follow the first minimal graph tutorial. Documentation says there is a Node#relation method to traverse relations but there is no such method neither from latest version at Maven central (10) nor from the current code version (11-SNAPSHOT).

screen shot 2018-02-28 at 10 28 04

Aurélien

abourdon avatar Feb 28 '18 09:02 abourdon

Hello @abourdon , thanks for your interest. I Just updated the samples to follow the latest Greycat version 11-SNAPSHOT. Please check the code here: https://github.com/datathings/greycat-samples We're sorry for the outdated documentation, because the whole concepts are changing too fast, once we stabilize we will pass again on the documentation. Thanks for your understanding.

assaad avatar Feb 28 '18 12:02 assaad

Hello @assaad,

No problem :-) I will then check the samples project instead.

Thanks!

Aurélien

abourdon avatar Feb 28 '18 12:02 abourdon