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

DOCS: Improve documentation #16

Open
fsanaulla opened this issue Sep 22, 2017 · 2 comments
Open

DOCS: Improve documentation #16

fsanaulla opened this issue Sep 22, 2017 · 2 comments

Comments

@fsanaulla
Copy link
Owner

fsanaulla commented Sep 22, 2017

If you have any ideas, how I can improve documentation - leave notes here. Feel free to open a PR.

@fsanaulla fsanaulla changed the title Help with docs grammar Improve documentation Oct 26, 2018
@fsanaulla fsanaulla reopened this Oct 26, 2018
@fsanaulla fsanaulla changed the title Improve documentation DOCS: Improve documentation Oct 26, 2018
@ioreskovic
Copy link

You are probably aware of it, but just to remind you if you aren't.

The example in README.md uses this class as a model:

case class Resume(
  @tag id: String,
  @tag candidateName: String,
  @tag candidateSurname: String,
  @field position: String,
  @field age: Option[Int],
  @field rate: Double,
  @timestamp created: Long
)

However, a snippet from macros module reveals that Option is only supported on tag values (which can only be Strings)

  private val TIMESTAMP_TYPE = tpdls[Long]

  private val SUPPORTED_TAGS_TYPES =
    Seq(tpdls[Option[String]], tpdls[String])

  final private val SUPPORTED_FIELD_TYPES =
    Seq(tpdls[Boolean], tpdls[Int], tpdls[Double], tpdls[String], tpdls[Float], TIMESTAMP_TYPE)

@fsanaulla fsanaulla added this to the Documentation milestone Dec 27, 2018
@wpoosanguansit
Copy link

wpoosanguansit commented Jan 19, 2019

It would be helpful to have sample comparing to the code using @tag scala-influxdb-client since many people will be familiar with it first. Like:

val point = Point("cpu", System.currentTimeMillis())
database.write(point,
               precision = Precision.MILLISECONDS,
               consistency = Consistency.ALL, 
               retentionPolicy = "custom_rp")

etc.

@fsanaulla fsanaulla pinned this issue Jan 19, 2019
@fsanaulla fsanaulla removed this from the Documentation milestone Jan 19, 2019
@fsanaulla fsanaulla added this to the Documentation milestone Feb 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants