looqbox / guide Goto Github PK

Describe what is wrong

Navbar is currently being ordered by alphabetical order, index.md is the exception.

Describe what was expected

Order by something that is not necessary alphabetical.

Additional context

None.

Describe what is wrong
There is no example on how scripts should be implemented, their expected complexity, and when a scripts should be broken down in multiple script to avoid a overly complex script

Describe what was expected
A cookbook section showing at least one case (without code) on how scripts should be organized, and how to link scripts to help a user navigate between them

Additional context
If i'm a new user, should I implement a script with multiple optional groupBys, or break one response/script into multiple?

Describe what is wrong
There is no explanation on how to set default values for different entities

Describe what was expected
A cookbook section exemplifying how to set default values for $date (most important), $store and at least one more example

Additional context
New users may create 2 different responses/scripts, one with a default value, and another one with a entity to be used as filter, for example

• Response with the keywords "sales", so user can search for sales with a hardcoded date
• Response with the keywords "sales" and "$date", so user can search for sales with a $date as dynamic filter

The example above is a bad pattern, and can be easily replaced by a optional "$date" with a default value

• Looq Response

  • This part is ok, but I think that it should be more clearly that this function NEED to be inside the script or it will not work.
  • Maybe it should explain what is par? I think that a lot of people really don't know what this is and only put in the scripts because it has to be there.

• Testing

  • I think that some users will have problem only with this example. The problem here is that some entities are vector and others are lists (like $date), reading this maybe the user pass something like:

  looq.testQuestion(
    list(
     "$date" = "2018-10-04" 
   )
  )
  

  and the right form is:

  looq.testQuestion(
    list(
     "$date" = list("2018-10-04", "2018-10-04") 
   )
  )
  

• I have a feeling that with this example a LOT of developers will create all the script inside the looq.response and this should be considered an awful code. Maybe would be great to print the message in other function and show the use of looq.responseFrame..

Describe what is wrong
There is no example to create different types of drills, and when to use them

Describe what was expected

A cookbook sections showing how to implement drills in the script, and how it helps users
At least one case with entities that needs to be passed over the drills