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

#291 Fix EU REACH, and some other miscellaneous documentation improvements #343

Merged
merged 5 commits into from
Aug 25, 2023

Conversation

Andy-Grigg
Copy link
Collaborator

@Andy-Grigg Andy-Grigg commented Aug 24, 2023

Closes #291

After the move to use the latest version of the Restricted Substances database for CI, we now see the effects of changing from 'REACH' to 'EU REACH':

https://bomanalytics.grantami.docs.pyansys.com/version/dev/examples/0_Getting_started.html#View-query-results

image

The REACH legislation 'Short title' was changed from 'REACH - The Candidate List' to 'EU REACH - The Candidate List' to disambiguate from UK REACH, China REACH, Korea REACH, etc. As a result, the examples now return zero results.

This PR replaces 'REACH' with 'EU REACH' everywhere, which should reinstate the results. Check the built docs in the pre-merge checks to confirm.

I have also made a few other miscellaneous documentation changes while I was in the code:

  • Fixed a missing space in a connection error string
  • Replaced 'localhost' with 'my_server_name', to be consistent with jupyter notebook examples
  • Added clarification as to what should be used for the legislation_name parameter. Note that we might change this to use the legislation id instead. At this point we could change the parameter name, causing people to adjust their scripts to avoid a silent failure.

@Andy-Grigg Andy-Grigg requested a review from da1910 August 24, 2023 18:10
@codecov-commenter
Copy link

codecov-commenter commented Aug 24, 2023

Codecov Report

Merging #343 (0fdbf28) into main (ef7903d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #343   +/-   ##
=======================================
  Coverage   95.23%   95.23%           
=======================================
  Files          10       10           
  Lines        1386     1386           
=======================================
  Hits         1320     1320           
  Misses         66       66           
Files Changed Coverage Δ
src/ansys/grantami/bomanalytics/_connection.py 88.63% <ø> (ø)
src/ansys/grantami/bomanalytics/_query_results.py 97.36% <ø> (ø)
src/ansys/grantami/bomanalytics/indicators.py 93.10% <ø> (ø)
src/ansys/grantami/bomanalytics/queries.py 98.20% <ø> (ø)

@Andy-Grigg
Copy link
Collaborator Author

The built examples contain a populated list of impacted substances:

image

@da1910 da1910 enabled auto-merge August 25, 2023 09:46
@da1910 da1910 added this pull request to the merge queue Aug 25, 2023
Merged via the queue into main with commit a83fc52 Aug 25, 2023
16 checks passed
@ludovicsteinbach ludovicsteinbach deleted the doc/291-eu-reach branch January 17, 2024 10:27
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.

Update Basic usage example
3 participants