gkamradt / langchain-tutorials

Overview and tutorial of the LangChain Library
6.63k stars 1.92k forks source link

How to report a mistake in documentation? #23

Closed famunir closed 1 year ago

famunir commented 1 year ago

Hello lang-chain devs,

How do I report a mistake in documentation? I was not sure if this is the right forum for pointing this out.

The sentence in documentation should probably read:

A text embedding model takes a piece of text as input and returns a numerical representation of that text in the form of a list of floats.

The original documentation is missing "returns a".

Ablesius commented 1 year ago

hi @famunir,

the documentation you're referring to is from LangChain itself, not from this repo, if I see correctly. So the "correct" way would be to report the issue there - or open a PR in their repo with the changed line (if you can find it; I've just tried and I can't seem to find the exact repo location) :)

Does that help you?

Best, Alex

famunir commented 1 year ago

Sure, thanks Alex.

I can't find that repo either. I will mention the repo here, if I find it.