Skip to content

Commit

Permalink
docs: update some comments (#68)
Browse files Browse the repository at this point in the history
* Remove unnecessary comments from dependabot

* Remove '# ' from LICENSE title

* Simplify comments in `.editorconfig`
  • Loading branch information
germanfrelo authored Jan 20, 2025
1 parent c26d961 commit ff568e6
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 32 deletions.
43 changes: 14 additions & 29 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# https://editorconfig.org

# About EditorConfig & Prettier:
# When using both, since they have some options in common, the best way to avoid conflicts between them is to configure those options only in the .editorconfig file. Prettier will use them instead of its own defaults. More info:
# - https://prettier.io/docs/en/configuration#editorconfig
# - https://joepkockelkorn.com/blog/combining-gitattributes-editorconfig-and-prettier

# ----------------------------------------
# NOTE:
# EditorConfig and Prettier share some options. To avoid conflicts between them, only configure these options in the .editorconfig file. Prettier will use them instead of its own defaults.
# Refs. https://prettier.io/docs/en/configuration#editorconfig and https://joepkockelkorn.com/blog/combining-gitattributes-editorconfig-and-prettier

# Stop the editor from looking for .editorconfig files in parent directories
root = true
Expand All @@ -29,24 +24,14 @@ trim_trailing_whitespace = false # 8
indent_style = space
indent_size = 2

# ----------------------------------------

# 1. See https://www.w3.org/International/questions/qa-html-encoding-declarations
# 2. See https://aleksandrhovhannisyan.com/blog/crlf-vs-lf-normalizing-line-endings-in-git
# 3. See:
# - https://stackoverflow.com/a/729795/10015695
# - https://unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file
# 4. Trailing whitespace has no purpose. Consistent formatting throughout the source code makes it easier to read
# 5. See:
# - https://gomakethings.com/tabs-are-objectively-better-than-spaces
# - https://alexandersandberg.com/articles/default-to-tabs-instead-of-spaces-for-an-accessible-first-environment
# - https://zwyx.dev/blog/indentation-for-accessibility
# - https://github.com/pointfreeco/swift-composable-architecture/discussions/2340
# - https://lea.verou.me/blog/2012/01/why-tabs-are-clearly-superior
# 6. See https://github.com/DavidAnson/markdownlint/blob/main/doc/md010.md
# 7. See https://github.com/DavidAnson/markdownlint/blob/main/doc/md007.md
# 8. See:
# - https://www.markdownguide.org/basic-syntax/#line-breaks
# - https://github.com/DavidAnson/markdownlint/blob/main/doc/md009.md
# - https://code.visualstudio.com/docs/languages/markdown#_keep-trailing-whitespace-in-order-to-create-line-breaks
# 9. See https://localheinz.com/articles/2023/02/06/indenting-yaml-files
# ---

# 1. https://www.w3.org/International/questions/qa-html-encoding-declarations
# 2. https://aleksandrhovhannisyan.com/blog/crlf-vs-lf-normalizing-line-endings-in-git
# 3. https://stackoverflow.com/q/729692/10015695
# 4. https://softwareengineering.stackexchange.com/q/121555
# 5. https://gist.github.com/germanfrelo/fc3ac17ff5bd78b7bf0786734f15d8b4
# 6. https://github.com/DavidAnson/markdownlint/blob/main/doc/md010.md
# 7. https://github.com/DavidAnson/markdownlint/blob/main/doc/md007.md
# 8. https://gist.github.com/germanfrelo/513086438cc38a6dadecb4ff49a46af4
# 9. https://localheinz.com/articles/2023/02/06/indenting-yaml-files
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MIT License
MIT License

Copyright (c) 2025 Germán Freixinós López

Expand Down

0 comments on commit ff568e6

Please sign in to comment.