docs: :memo: add detail to search docstrings

transition-zero / tz-client

A client repository for accessing FEO data programmatically.

https://docs.feo.transitionzero.org

Apache License 2.0

21 stars 4 forks source link

Closed Tomkourou closed 9 months ago

Tomkourou commented 9 months ago

Added some additional detail to the Node and Asset search functions to clarify their behaviour to users.

[ ] Dependencies install correctly in a clean environment and code executes;
[ ] Test coverage extended; created tests fail without the change (if possible);
[ ] All tests passing;
[ ] Commits follow a type convention (e.g. https://gist.github.com/brianclements/841ea7bffdb01346392c#type);
[ ] Extended the README, documentation and/or docstrings, if necessary;

vercel[bot] commented 9 months ago

@Tomkourou is attempting to deploy a commit to the transition-zero Team on Vercel.

To accomplish this, @Tomkourou needs to request access to the Team.

Afterwards, an owner of the Team is required to accept their membership request.

If you're already a member of the respective Vercel Team, make sure that your Personal Vercel Account is connected to your GitHub account.

vercel[bot] commented 9 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
feo-client	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 29, 2023 5:10pm

Lkruitwagen commented 9 months ago

I think this is quite confusing - I'd rather improve the search method. should be a quick change

joconnor-ecaa commented 9 months ago

Related to #63

joconnor-ecaa commented 9 months ago

Closing as it looks like this is not wanted