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

Fix Documentation to properly match/display correct environment for Pong #1257

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kuds
Copy link

@kuds kuds commented Jan 14, 2025

Description

The Python script that generates the markdown file for each environment does a partial match when searching for the correct import string. This works for all environments except for pong, as it leads to multiple results being returned and the first one selected. This pull request changes that match from a partial match to an exact match to correctly display the correct import statement in the markdown documents.

Fixes #1235

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Screenshots

Before
Screenshot 2025-01-14 at 5 16 20 PM

After
Screenshot 2025-01-14 at 5 14 55 PM

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

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.

[Bug Report] Pong Documentation has the wrong import in sample code
1 participant