Skip to content

Add .editorconfig and revise doc files with style#1808

Merged
jimklimov merged 12 commits intonetworkupstools:masterfrom
jimklimov:autostyle
Jan 14, 2023
Merged

Add .editorconfig and revise doc files with style#1808
jimklimov merged 12 commits intonetworkupstools:masterfrom
jimklimov:autostyle

Conversation

@jimklimov
Copy link
Copy Markdown
Member

@jimklimov jimklimov commented Jan 12, 2023

While not a full-fledged solution to #894 goals, this is a first step allows many editors and IDEs to save consistent representation/markup of the codebase. For a practical test-drive, text files were edited to drop trailing whitespaces (also testing exceptions by filenames) and wrap lines too long. Bits of docs were refreshed along the way.

At this time there is no special automation involved to check/enforce this style setting (like there would be with clang-format). However if there are "offences" in some codebase parts, it should hopefully "converge" to some one standard over time as those files get edited and saved by cooperating tools.

@jimklimov jimklimov added documentation CI Entries related to continuous integration infrastructure (here CI = tools + scripts + recipes) refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings labels Jan 12, 2023
@jimklimov jimklimov added this to the 2.8.1 milestone Jan 12, 2023
@jimklimov jimklimov requested a review from aquette January 12, 2023 17:39
@jimklimov jimklimov merged commit 27a2c45 into networkupstools:master Jan 14, 2023
@jimklimov jimklimov deleted the autostyle branch January 14, 2023 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Entries related to continuous integration infrastructure (here CI = tools + scripts + recipes) documentation refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant