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

Addressing compatibility issue for shell script in CONTRIBUTING.md #361

Merged
merged 2 commits into from
Mar 18, 2024

Conversation

azzamh15
Copy link
Contributor

@azzamh15 azzamh15 commented Mar 16, 2024

Addresses compatibility issues with the shell script, making it work on zsh as well. Previously, the script was failing on zsh as square brackets are used for pattern matching in zsh. By adding double quotes, the script now functions correctly across different shell environments.

pip install -e ".[dev,docs]"

@azzamh15 azzamh15 requested a review from gnikit as a code owner March 16, 2024 04:33
Copy link

codecov bot commented Mar 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.52%. Comparing base (3386073) to head (e6a7857).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #361   +/-   ##
=======================================
  Coverage   87.52%   87.52%           
=======================================
  Files          35       35           
  Lines        4760     4760           
=======================================
  Hits         4166     4166           
  Misses        594      594           

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

@azzamh15 azzamh15 mentioned this pull request Mar 16, 2024
@azzamh15
Copy link
Contributor Author

Consistent with
#360 (review) by @gnikit

We use sh & bash for development, not zsh so the docs are consistent with the selection. Users of other shells should adapt the instructions. Burden of such documentation is rarely taken up by the project (see sktime for example). The implicit assumption is that developers can figure out how to install a generic Python package on their machine.

The most readable solution to a generic prompt would be to use double quotes, like in pandas

pip install -e ".[dev,docs]"

@gnikit gnikit merged commit 8e95ee9 into fortran-lang:master Mar 18, 2024
20 checks passed
@azzamh15 azzamh15 deleted the change-syntax-contributing branch April 13, 2024 03:34
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.

None yet

2 participants