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

Discrepancy Between Documentation and Code Regarding Environment Variable Names #162

Open
moraneden opened this issue May 9, 2024 · 0 comments

Comments

@moraneden
Copy link

I've encountered an inconsistency in the documentation compared to the actual code implementation regarding the environment variables for the EPO API credentials. According to the documentation available at https://patent-client.readthedocs.io/en/latest/getting_started.html, users are instructed to set the environment variables as PATENT_CLIENT_EPO_API_KEY and PATENT_CLIENT_EPO_SECRET.

However, upon reviewing the code, it appears that the correct environment variable for the secret key is actually PATENT_CLIENT_EPO_API_SECRET, not PATENT_CLIENT_EPO_SECRET as stated in the documentation. This discrepancy could potentially lead to confusion and issues for new users trying to configure their environment correctly.

Could the documentation be updated to reflect the correct environment variable name (PATENT_CLIENT_EPO_API_SECRET) to ensure clarity and prevent any configuration issues?

I hope this helps! Let me know if there's anything else you'd like to adjust.

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

No branches or pull requests

1 participant