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

Codespell report for "RethinkDB" (on fossies.org) #7102

Open
jschleus opened this issue Nov 10, 2022 · 4 comments
Open

Codespell report for "RethinkDB" (on fossies.org) #7102

jschleus opened this issue Nov 10, 2022 · 4 comments

Comments

@jschleus
Copy link

The FOSS server fossies.org - supporting now also the RethinkDB project - offers among others a feature named "Source code misspelling reports". Such reports are normally only generated on request, but as Fossies administrator I have just created such a codespell based analysis for the "RethinkDB" GitHub v2.4.x development version:

 https://fossies.org/linux/test/rethinkdb-v2.4.x-snap.tar.gz/codespell.html

That URL should redirect always to the report for the latest version identified by the short GitHub commit ID and a year-month-day string (YYMMDD) representing the according git pull date (mostly = commit date). The data are residing within a special restricted "test" folder that isn't really integrated into the standard Fossies services and should also not be accessible to search engines. The report should be available at least for some weeks and is continuously updated (currently with a half-hourly refresh rate).

By the way, the context type of the spelling errors and typos are marked by a single character (within the sortable column "T"): The less interesting, probably not user visible ones (in "comments") are greyed, while the probably more interesting ones are black-colored. Especially interesting may be unassigned errors marked by a "?" since they may be contained in the source code itself. Some more according information is offered by a tooltip if the mouse is over the string "error context type character" above the table, over the "T" in the table header or over such a context character itself within the table. If JavaScript is enabled all table columns are sortable.

Although after a first review some obviously wrong matches ("False Positives" = FPs) are already filtered out (ignored) please inform me if you find more of them so that I can exclude them if applicable.

Most misspellings are found only in source code comments but e.g. the typo "processs" in the file test/common/driver.py (at line 892) may affect the code itself.

Just for information there are also three supplemental pages showing some used "codespell" configuration details, all obvious false positives and a misspelling history (log).

OK, spelling corrections certainly have a low priority, but they may also contribute to the overall quality of a software project. So I hope that the report can nevertheless be a little bit useful.

@srh srh mentioned this issue Nov 14, 2022
1 task
@srh
Copy link
Contributor

srh commented Nov 14, 2022

Thank you for the report. I've fixed in #7103 most typos except for those in the comments and a few in tests' yaml files which I didn't bother to look at.

@srh
Copy link
Contributor

srh commented Dec 15, 2023

Closing, now that #7103 is merged. Anybody who wants to fix the other typos is welcome to reopen. Maybe we want those in comments in src to be fixed (to avoid noise). I probably chose not to for extreme effort minimization, in order to avoid possible merge conflicts.

@srh srh closed this as completed Dec 15, 2023
@jschleus
Copy link
Author

Ok.

But although I'm a coding layman I had the impression that the suspected typos

$(BUILD_DIR)/converage.info currently at line 46 of the file mk/tools.mk (should be coverage.info)

and

self.processs = None currently at line 892 of the file test/common/driver.py (should be self.process)

affects the code itself.

@srh
Copy link
Contributor

srh commented Dec 16, 2023

Okay, maybe we want to reopen then.

@srh srh reopened this Dec 16, 2023
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

No branches or pull requests

2 participants