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

Cleanup of flycheck/flymake info and warning messages #449

Merged
merged 2 commits into from
Jan 20, 2024

Conversation

matsl
Copy link
Collaborator

@matsl matsl commented Jan 19, 2024

What

Cleanup of flycheck/flymake info and warning messages.

Why

We should keep the code base as clean as possible.

Note

This is a more or less mechanical go through of all info and warnings produce by flycheck and trying to resolve them. (I hope and think that flycheck uses the same backbone functions to check for problems as flymake so this work would cover for a similar exercise using flymake.)

I know you are not a big fan of these huge PRs but it is mostly small changes affecting docstrings. There are a few code changes but should not affect execution.

Common things that are fixed are:

  1. Error message shall not end in a period.
  2. There shall be no extra whitespace at end of line.
  3. Docstring is missing.
  4. Docstring is missing arg in capital letters.
  5. Key control sequence is not properly escaped and quoted.
  6. Dired should be written as Dired, with a capital first letter, everywhere in docstrings.
  7. ...

Not all of these are fixed either. Not all functions have been given docstrings. Not all parameters have been added in capital letters.I might have missed something. Anyway -- I have tried fix that but given up due to it either does not make sense to add it or most often, I could not come up with something decent enough so juts left it as is.

There is no Changelog for this work either. If it gets accepted I can add a Changelog item covering the whole initiative.

@matsl matsl force-pushed the matsl-rsw-cleanup-of-low-prio-things branch from b7216bb to cbff226 Compare January 20, 2024 00:00
@matsl matsl requested a review from rswgnu January 20, 2024 00:00
@rswgnu
Copy link
Owner

rswgnu commented Jan 20, 2024 via email

Copy link
Owner

@rswgnu rswgnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good. Just a number of simple updates and should be good to go.

hmouse-sh.el Show resolved Hide resolved
hmouse-tag.el Outdated Show resolved Hide resolved
hmouse-tag.el Outdated Show resolved Hide resolved
hmouse-tag.el Outdated Show resolved Hide resolved
hmouse-tag.el Outdated Show resolved Hide resolved
hui-mini.el Outdated Show resolved Hide resolved
hui-window.el Outdated Show resolved Hide resolved
hui-window.el Outdated Show resolved Hide resolved
hypb.el Outdated Show resolved Hide resolved
hyrolo.el Outdated Show resolved Hide resolved
@matsl matsl force-pushed the matsl-rsw-cleanup-of-low-prio-things branch from cbff226 to 0546b69 Compare January 20, 2024 19:23
@matsl matsl requested a review from rswgnu January 20, 2024 19:24
@matsl matsl merged commit 74ba1fd into rsw Jan 20, 2024
@matsl matsl deleted the matsl-rsw-cleanup-of-low-prio-things branch January 20, 2024 19:26
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