search

milvus-io / milvus-sdk-go

Go SDK for Milvus.
Apache License 2.0
349 stars 110 forks source link

[Document] Elaborate Golang API reference #191

Open LocoRichard opened 3 years ago

LocoRichard commented 3 years ago

Is there anything that's missing or inappropriate in the docs? Please describe.

Content in Go API reference is insufficient. Clarification on collection schema in create_collection.md is particularly needed.

Describe your suggestion

Please submit a pull request and supplement the content. Contribution to any of the API reference documents under https://github.com/milvus-io/milvus-sdk-go/blob/master/docs/ is welcomed.

Suggested Step

Please find all API reference doc at https://github.com/milvus-io/milvus-sdk-go/tree/master/docs and the code at https://github.com/milvus-io/milvus-sdk-go/tree/master/client.

You will need to add content according to the code.

Should you need any assistance, please feel free to contact us.

DiptoChakrabarty commented 3 years ago

hey I am interested in this issue , just to clarify we have to provide a reference of the schema used in the create_collection.md , the schema is present here https://github.com/milvus-io/milvus-sdk-go/blob/7410632233597d4af58df727682ffb29f1d1d51d/entity/schema.go#L20-L25

Is a table view of the schema in the doc sufficient for this?

LocoRichard commented 3 years ago

That would be nice @DiptoChakrabarty . Thank you for your interest in contributing to us! I have assigned the issue to you. @congqixia can help you with any technical difficulties. Please bear with us if you do not receive prompt replies as we are going to have a national holiday for the next week.

LocoRichard commented 3 years ago

/assign @DiptoChakrabarty

DiptoChakrabarty commented 3 years ago

That would be nice @DiptoChakrabarty . Thank you for your interest in contributing to us! I have assigned the issue to you. @congqixia can help you with any technical difficulties. Please bear with us if you do not receive prompt replies as we are going to have a national holiday for the next week.

Sure , thank you Ill send my PR