docs(elastricsearch): add description fiels #9693
Conversation
dim-ops
force-pushed
the
docs/add-elastricsearch-description
branch
from
e8dec55 to
ca86fac
Compare
dim-ops
changed the title
github-actions
bot
added
ingestion
| ) | ||
| collapse_urns: CollapseUrns = Field( | ||
| default_factory=CollapseUrns, | ||
| default_factory=CollapseUrns, description="Urn of collapse." |
There was a problem hiding this comment.
In this case the problem seems to be in doc generation instead. CollapseUrns. urns_suffix_regex is documented properly. This documentation does not really explain the functionality.
There was a problem hiding this comment.
Same for this #9690 ?
There was a problem hiding this comment.
That one I merged in. But urn of collapse does not really tell what this is doing. The underlying model has more details which are useful but are not showing up in the docs. If you feel comfortable reviewing the docgen code and making changes in that please do. Otherwise someone in our team can attempt that when they get a chance.
dim-ops
force-pushed
the
docs/add-elastricsearch-description
branch
from
c60f6d2 to
dd51020
Compare
dim-ops
force-pushed
the
docs/add-elastricsearch-description
branch
from
dd51020 to
a17d3ad
Compare
|
Up @anshbansal please 🙏 |
|
In the long run we would like to fix this doc generation bug. In the short term I am merging this in as I understand it can cause confusion |
Add descriptions to elasticseach args
Checklist