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

uniprop-* are not documented #1045

Closed
AlexDaniel opened this issue Dec 11, 2016 · 9 comments
Closed

uniprop-* are not documented #1045

AlexDaniel opened this issue Dec 11, 2016 · 9 comments
Labels
docs Documentation issue (primary issue type) NOTSPECCED need roast tests before documenting update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.

Comments

@AlexDaniel
Copy link
Member

@AlexDaniel AlexDaniel added the docs Documentation issue (primary issue type) label Dec 11, 2016
@Altai-man
Copy link
Member

Please, can you clarify this issue? What is wrong with this - http://storage3.static.itmages.com/i/16/1211/h_1481449847_3051205_6b92fa7717.png ?

@AlexDaniel
Copy link
Member Author

It says that there is a “method unival” in Int, but there is no such method in Int. The method form is actually in cool which calls the sub form… uh, it's complicated!

See this pull request (because after it this is going to change): rakudo/rakudo#945

@Altai-man
Copy link
Member

So the task is to understand current situation and move sub/method descriptions from OldType to NewType(with optional examples update)?

@AlexDaniel
Copy link
Member Author

Yes, but we probably want to wait just a little bit for this PR to go through.

@samcv
Copy link
Collaborator

samcv commented Dec 11, 2016

PR has gone through.

unival, unival, uniprop, uniprop-int, uniprop-bool, uniprop-st, uniprops, unimatch, uniname, unanames are all now in Cool

@Altai-man
Copy link
Member

Altai-man commented Jan 23, 2017

List of work:

  • unival - in Str and Int
  • uniprop - in Cool
  • uniprop-int - mentioned in Cool, but doesn't described(do we need it?)
  • uniprop-bool - mentioned in Cool, but doesn't described(do we need it?)
  • uniprop-str - mentioned in Cool, but doesn't described(do we need it?)
  • uniprops - in Cool
  • unimatch - in Cool
  • uniname - in Cool
  • uninames - in Cool

@coke coke added the update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. label Aug 26, 2017
@JJ
Copy link
Contributor

JJ commented May 6, 2018

The three "dash" properties, do we need to describe them? That would leave only unival, which is already described in Int and Str

@AlexDaniel
Copy link
Member Author

AlexDaniel commented May 6, 2018

We do need to document them, but either I don't understand their functionality or these subs are simply broken. See 39241d1.

Another thing is that there's a table on Cool that says which sub coerces to what, and I think that for some of the subs mentioned here the table is incorrect (for uniprop at least).

@samcv
Copy link
Collaborator

samcv commented May 6, 2018

The three "uniprop-str", "uniprop-int" and "uniprop-bool" are not specced and essentially call the nqp ops directly. I.e. if you request the incorrect type then it will give you bogus information. For example, requesting the int value of something stored as an enum in moarvm will return the enum number and not the expected result.

Though maybe MoarVM should not return bogus information, it's also rakudo's job not to ask for the correct type (we have logic in rakudo so the properties resolve correctly to the proper type).

The only things .uniprop-int may be useful for is Canonical_Combining_Class which has strings as well as numbers specified. BTW .uniprop-int for CCC gives the enum's value not the assigned integer number. Though the numbers are correct relative to each other (the CCC numbers are most important relative to each other when doing rearrangement of codepoints inside a grapheme, to order the combining marks in the proper order to form NFG).

@JJ JJ added the NOTSPECCED need roast tests before documenting label May 9, 2018
@JJ JJ changed the title unival is in Str, not Int uniprop-* are not documented May 9, 2018
@JJ JJ removed the JJ TPF Grant label May 14, 2018
JJ added a commit that referenced this issue May 29, 2018
Initially to close #1032.

It will help also with #2059, #1518, #1045 and #1747.

Initially, `emit` has been added to a `control` section. Could be
moved later on.
@JJ JJ closed this as completed in 61d24ab Jul 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type) NOTSPECCED need roast tests before documenting update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.
Projects
None yet
Development

No branches or pull requests

5 participants