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

Add missing reference terms from reference import #120

Open
jeremydouglass opened this issue Jun 13, 2017 · 10 comments
Open

Add missing reference terms from reference import #120

jeremydouglass opened this issue Jun 13, 2017 · 10 comments

Comments

@jeremydouglass
Copy link
Member

jeremydouglass commented Jun 13, 2017

Currently the reference is seeded by importing reference entries, description text, and cross-references from the Python mode.

However, Python mode contains many Python-specific reference entries which are not in the Processing(Java) API, and which will not be in Python.R. For example:

  • dict_items
  • dict_iteritems
  • dict_keys
  • dict_update
  • dict_values
  • dictionary

70009bc#diff-67374dee80d03cf169846122755bef45

Some python-specific entries include:

  • Composite tuple, dictionary, string
  • Dictionary Methods
  • List Methods
  • List Functions
  • String Methods

https://processing-r.github.io/Processing.R-docs/

These need to be removed -- either through an ignore list for the automatic import script, or, if the import was one-time-only, then manually removed (along with any cross-references).

Note however that if there ever is a re-import then we have to clean all over again, so an ignore list (processed by either the import script or a cleanup removal script) might be better approach than a manual cleanup commit.

@gaocegege
Copy link
Member

gaocegege commented Jun 14, 2017

Yeah, and there are some items about float and built-in types, which we also need to remove. Besides this, some descriptions include Python Mode, we need to rewrite them.

@jeremydouglass
Copy link
Member Author

jeremydouglass commented Jun 26, 2017

Good work, but I think we need to do a bit more work on this before closing the issue, and there should be a pull request review.

Python-specific reference terms are keywords from the Python language.

For example, def -- this is a Python keyword:

Another example, add_library -- this is specific to Python mode, until we decided to implement something like it in R (which might not have the same name).

Another example, False -- Processing(Java) uses built-in boolean false true; Python uses Boolean, False, True; I believe that R uses the built-ins FALSE and TRUE.

While reviewing this issue, see also my comments on recent pull requests:

@gaocegege
Copy link
Member

Sorry, my mistake.

@gaocegege gaocegege changed the title Remove Python-specific reference terms from reference import Add missing reference terms from reference import Aug 20, 2017
@jeremydouglass
Copy link
Member Author

Currently I believe that all Python references have been removed from the docs, and R references (including importLibrary) were added. Can this issue be closed?

@jeremydouglass
Copy link
Member Author

Actually, I see importLibrary in the reference, but not library. Perhaps open adding that as a separate issue.

@gaocegege
Copy link
Member

gaocegege commented Aug 26, 2017

No, we miss the function nf and so on.

@gaocegege
Copy link
Member

library is not a valid item in our mode, IMO. 🤔

@jeremydouglass
Copy link
Member Author

No, we miss the function nf and so on.

Got it. That will be good for a community contribution.

library is not a valid item in our mode, IMO.

I don't understand what you mean. We have a whole section on the repo homepage about library:

R Packages: library()

Processing.R has limited support for R packages. It will automatically download R packages that are requested using the library() function, so you can use packages directly.

...but we don't have library listed on the reference page.

@gaocegege
Copy link
Member

Oh, my mistake. Yeah we don't have the doc for library

@jeremydouglass jeremydouglass added this to the v1.0.8 milestone Aug 6, 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

2 participants