Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make documentation clear for non-privileged users #12

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

jose-caballero
Copy link
Contributor

The previous snippets in the documentation only work if the user have admin privileges. Documentation now makes more clear what queries need to be executed for regular non-privileged users.

Also, documentation gives some clue on how to find out the exact value of the cloud domain name to be passed as first argument to query.run()

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (65bcd72) to head (b87f3fc).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #12   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files         111      111           
  Lines        4244     4244           
=======================================
  Hits         4225     4225           
  Misses         19       19           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/user_docs/USAGE.md Outdated Show resolved Hide resolved
The previous snippets in the documentation only work if the user have
admin privileges. Documentation now makes more clear what queries need
to be executed for regular non-privileged users.

Also, documentation gives some clue on how to find out the exact value
of the cloud domain name to be passed as first argument to query.run()
@anish-mudaraddi anish-mudaraddi merged commit 07b9186 into main Jan 7, 2025
13 checks passed
@anish-mudaraddi anish-mudaraddi deleted the improve_documentation branch January 7, 2025 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants