Rework pyTransition README to integrate actual example scripts #1171
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
greenscientist
force-pushed
the
validatePythonExampleReadme
branch
from
5dbfb10 to
92f793a
Compare
greenscientist
force-pushed
the
validatePythonExampleReadme
branch
2 times, most recently
from
3701382 to
fb1e320
Compare
greenscientist
changed the title
|
Updated with fixed routing.py |
greenscientist
force-pushed
the
validatePythonExampleReadme
branch
from
fb1e320 to
633385f
Compare
tahini
requested changes
Dec 19, 2024
pyTransition/README.md
Outdated
| # Get the number of alternative paths for the current mode | ||
| geojsonPaths = value["pathsGeojson"] | ||
| geojsonPath = value["pathsGeojson"] |
We add a python script (code-to-readme.py, created by Claude.AI) which will replace marked script sections with actual content of scripts. This is driven by a configuration files, readme-examples-config.yaml which define name of script file and section of the script to extract. We need to run the following to update the README file: python3 code-to-readme.py --readme README.md --config readme-examples-config.yaml Documentation about this script usage and the config file format is in the script header We extracted 4 scripts from the previous README and put them in the examples directory. Scripts errors were fixed
greenscientist
force-pushed
the
validatePythonExampleReadme
branch
from
633385f to
c5dd30e
Compare
|
@tahini , requesting a review, I've added a CI config |
…EADME match Run the code_to_readme.py to insure that the user have done it when changing script and README
greenscientist
force-pushed
the
validatePythonExampleReadme
branch
from
b25dacc to
004a90b
Compare
tahini
approved these changes
Dec 19, 2024
GabrielBruno24
approved these changes
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We add a python script (code-to-readme.py, created by Claude.AI) which will replace marked script sections with actual content of scripts.
This is driven by a configuration files, readme-examples-config.yaml which define name of script file and section of the script to extract.
We need to run the following to update the README file: python3 code-to-readme.py --readme README.md --config readme-examples-config.yaml
Documentation about this script usage and the config file format is in the script header
We extracted 4 scripts from the previous README and put them in the examples directory. Some fixes were applied, but part of the scripts are still broken, we will fix in further commit.