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: Remove table, xml and primitive #130

Merged
merged 2 commits into from
Jun 26, 2017
Merged

docs: Remove table, xml and primitive #130

merged 2 commits into from
Jun 26, 2017

Conversation

gaocegege
Copy link
Member

@gaocegege gaocegege commented Jun 25, 2017

Close #120

Signed-off-by: Ce Gao [email protected]

@gaocegege gaocegege changed the title WIP: docs: Remove table, xml and primitive docs: Remove table, xml and primitive Jun 25, 2017
@gaocegege gaocegege merged commit f651de2 into master Jun 26, 2017
@gaocegege gaocegege deleted the doc/remove branch June 26, 2017 02:21
@jeremydouglass
Copy link
Member

jeremydouglass commented Jun 26, 2017

Question: the Table and XML classes and all of their methods are part of the Java API -- those classes are not Python mode-specific features, although I am not sure if Python mode implements the same methods those methods in the same way.

Why are they being removed? Is the idea that R has its own built-in methods for doing table manipulation, like using matrices?

Python documentation that does not belong in in R include core features of the Python language that are not part of the Processing Java API. These were included in the Python mode documentation but should not be in included in the R mode documentation. An example is dict -- dictionaries are a Python built-in that do not exist in Processing(Java), and also do not exist in R.

If you want to know whether a Python reference maps to the Java API you can compare the reference pages:

@gaocegege
Copy link
Member Author

gaocegege commented Jun 27, 2017

I remove this functions since R has a better support for table(matrix), and as for XML, I don't think it is necessary for R mode since I can't imagine the use scenarios. 🤔 Do you think if we need to add XML back?

@jeremydouglass
Copy link
Member

jeremydouglass commented Jul 4, 2017

Thinking about this more:

Table and XML are quite complex, and should be low priority in documentation. If there are implementation issues (e.g. if the load and save functions don't "just work") then they should also be low priority.

  1. Table: I agree that it would be very strange to use the Java API Table in an R sketch. If it turns out we are wrong I suppose it could be restored in a way that avoids collision or confusion between the R and Java modes. Fine to just take Table out.

  2. XML: Is it still available in the imported Java processing$ namespace? That might be the best approach -- leave it as automatically available, but undocumented (unless it conflicts with something, or is broken, or required complex mapping to make it available -- it is low priority).

For an R mode user who wants to work with XML, right now the default R package for XML is not available in renjin because it is C-based:

...although if our R packing importing is fully resolved, native R XML features might be available through XiMpLe:

@gaocegege gaocegege modified the milestone: Evaluation 2 Jul 12, 2017
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.

2 participants