Skip to content

docs: Add instruction when to use hyphens or underscores for file and folder names under FAQ #330

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

Merged

Conversation

bobleesj
Copy link
Collaborator

@bobleesj bobleesj commented Apr 23, 2025

Closes #329

Please check the rendered HTML screenshot below.

@bobleesj
Copy link
Collaborator Author

Screenshot 2025-04-23 at 5 15 31 PM

@sbillinge ready for review

Copy link

codecov bot commented Apr 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.63%. Comparing base (482eb41) to head (3d3ca24).
Report is 6 commits behind head on 202504-doc-command.

Additional details and impacted files
@@                 Coverage Diff                 @@
##           202504-doc-command     #330   +/-   ##
===================================================
  Coverage               52.63%   52.63%           
===================================================
  Files                       2        2           
  Lines                      19       19           
===================================================
  Hits                       10       10           
  Misses                      9        9           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge sbillinge merged commit f742815 into scikit-package:202504-doc-command Apr 23, 2025
4 checks passed
@sbillinge
Copy link
Collaborator

very nice!!!!!

@bobleesj bobleesj deleted the add-folder-name-readme branch April 23, 2025 23:33
@TingwenZhang
Copy link

@bobleesj @sbillinge
I noticed in https://github.com/scikit-package/scikit-package/tree/main/.codespell and https://github.com/scikit-package/scikit-package/tree/main/.github, and many other files under their subdirectories, we use _ for .txt , .md and .rst. Is this intended? Because the same is for all .codespell and .github folders under diffpy.

@bobleesj
Copy link
Collaborator Author

@TingwenZhang Great question. Thanks for asking. For the hidden files/folders, these are typically non-public facing and the naming convention is not chosen by us but by the developers of those applications. So it is important to follow their standard in order to config their apps. So, you can ignore the files under .codespell and .github.

But I will make it clearer in the documentation.

@sbillinge
Copy link
Collaborator

Thanks @bobleesj and @TingwenZhang great discussion.

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.

3 participants