Skip to content

docs: fix typos in Scaladoc comments and examples - #695

Open
Avicennasis wants to merge 1 commit into
criteo:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix typos in Scaladoc comments and examples#695
Avicennasis wants to merge 1 commit into
criteo:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

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.scala

  • defines how it mnaps -> defines how it maps
  • the Scheduler ensure that -> ensures (subject/verb agreement)
  • The scheduler also allow to -> also allows to
  • Utility that allow to define -> allows to define
  • immediatly -> immediately (3 occurrences: hourly, daily, monthly -- the
    weekly block already spells it correctly)
  • Defines an daily calendar -> a daily calendar
  • starting a midnight -> starting at midnight
  • timezone defines lightsaving ... 23 or 25 horus -> daylight saving ... hours

timeseries/.../timeseries/CuttleProject.scala

  • providing an Web UI -> a Web UI
  • @param description The project version as displayed in the UI. ->
    The project description ... (copy/paste from the @param version line above)
  • internal debug informations -> information

cron/.../cron/CronProject.scala

  • providing an Web UI -> a Web UI
  • Create 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 -> information

examples/.../HelloTimeSeries.scala

  • // This a very simple cuttle project -> This is a very simple
  • is just embeded into -> embedded
  • create a single executions for each 5 consequent partition ->
    a single execution for each 5 consequent partitions

core/.../Utils.scala

  • that 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 -> information
  • core/.../Scheduling.scala: A scheduler interpret ... and instanciate ->
    interprets ... instantiates; Immediatly the scheduler -> Immediately;
    debug state if neeed -> if needed; statistics informations -> information
  • timeseries/.../TimeSeriesScheduler.scala: the [[Backfill]] informations are provided -> information is provided
  • examples/.../HelloCustomScheduling.scala: is just embeded into -> embedded

Deliberately left alone

  • RetryStrategy.SimpleRetryStategy -- the misspelling is real, but it is a
    public API name defined in core/.../Executor.scala; renaming it would be a
    source-breaking change, so it is out of scope for a typo PR.
  • val splitted in core/.../Authentication.scala -- a local identifier.
  • allow(s) to <verb> -- used consistently 16 times across the repo, so it is
    house style rather than a typo; only the subject/verb agreement was corrected.
  • instanciate a trasactor in core/src/it/.../DatabaseITest.scala -- a test
    name string; happy to include it if you would like it fixed too.

No functional changes -- comments and documentation only.

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
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.

1 participant