docs: fix typos in Scaladoc comments and examples - #695
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix 30 spelling and grammar typos in Scaladoc comments, code comments and the
example projects. Documentation/comments only -- no code, identifiers or public
API names were changed, so behaviour is unaffected.
Findings from the report
timeseries/.../timeseries/package.scaladefines how it mnaps->defines how it mapsthe Scheduler ensure that->ensures(subject/verb agreement)The scheduler also allow to->also allows toUtility that allow to define->allows to defineimmediatly->immediately(3 occurrences: hourly, daily, monthly -- theweekly block already spells it correctly)
Defines an daily calendar->a daily calendarstarting a midnight->starting at midnighttimezone defines lightsaving ... 23 or 25 horus->daylight saving ... hourstimeseries/.../timeseries/CuttleProject.scalaproviding an Web UI->a Web UI@param description The project version as displayed in the UI.->The project description ...(copy/paste from the@param versionline above)internal debug informations->informationcron/.../cron/CronProject.scalaproviding an Web UI->a Web UICreate new projects using a timeseries scheduler.->a cron scheduler.(copy/paste from
CuttleProject; this is the cron project object)@param description The project version as displayed in the UI.->The project description ...internal debug informations->informationexamples/.../HelloTimeSeries.scala// This a very simple cuttle project->This is a very simpleis just embeded into->embeddedcreate a single executions for each 5 consequent partition->a single execution for each 5 consequent partitionscore/.../Utils.scalathat resolve automatically->resolves(3 occurrences)Additionally noticed
While checking the above I found the same misspellings a few files over and
fixed them in this branch too, so the codebase is consistent:
core/.../Logger.scala:output internal informations->informationcore/.../Scheduling.scala:A scheduler interpret ... and instanciate->interprets ... instantiates;Immediatly the scheduler->Immediately;debug state if neeed->if needed;statistics informations->informationtimeseries/.../TimeSeriesScheduler.scala:the [[Backfill]] informations are provided->information is providedexamples/.../HelloCustomScheduling.scala:is just embeded into->embeddedDeliberately left alone
RetryStrategy.SimpleRetryStategy-- the misspelling is real, but it is apublic API name defined in
core/.../Executor.scala; renaming it would be asource-breaking change, so it is out of scope for a typo PR.
val splittedincore/.../Authentication.scala-- a local identifier.allow(s) to <verb>-- used consistently 16 times across the repo, so it ishouse style rather than a typo; only the subject/verb agreement was corrected.
instanciate a trasactorincore/src/it/.../DatabaseITest.scala-- a testname string; happy to include it if you would like it fixed too.
No functional changes -- comments and documentation only.