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

Added danger hint when using windows paths #742

Merged
merged 5 commits into from
Dec 19, 2024
Merged

Conversation

SRaimondi
Copy link
Contributor

Added danger section in the Getting started section of the documentation when using paths in Windows with "\" that might generate escape sequences in the string if not treated properly. See related Issue #739 .

@SRaimondi SRaimondi added the documentation Improvements or additions to documentation label Dec 17, 2024
@SRaimondi SRaimondi self-assigned this Dec 17, 2024
Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.97%. Comparing base (80f16ca) to head (fd0c8cb).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #742   +/-   ##
=======================================
  Coverage   94.97%   94.97%           
=======================================
  Files         109      109           
  Lines        5696     5696           
  Branches      322      322           
=======================================
  Hits         5410     5410           
  Misses        285      285           
  Partials        1        1           
Flag Coverage Δ
direct-launch 91.57% <ø> (ø)
minimum-deps 93.18% <ø> (ø)
python-3.10 94.24% <ø> (ø)
python-3.11 94.17% <ø> (ø)
python-3.12 94.36% <ø> (ø)
server-2024R2 90.80% <ø> (ø)
server-2025R1 94.17% <ø> (ø)
server-2025R2 94.17% <ø> (ø)
server-latest 94.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

doc/source/intro.rst Outdated Show resolved Hide resolved
doc/source/intro.rst Outdated Show resolved Hide resolved
@greschd greschd self-requested a review December 18, 2024 15:32
@SRaimondi SRaimondi linked an issue Dec 19, 2024 that may be closed by this pull request
2 tasks
@SRaimondi SRaimondi merged commit e1c4808 into main Dec 19, 2024
33 checks passed
@SRaimondi SRaimondi deleted the docs/windows_path_warning branch December 19, 2024 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Opening acph5 file using a plain path fails
3 participants