Scripting: Parse stdlib files for parameter names #67837
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Task generateContextApiSpec takes optional system parameter
`jdksrc` with path to extracted java standard library source
files.
* stdlib source files are the source of `parameter_names` list
and the `javadoc` value.
* javadoc values may contain newlines and markup such as
`{@code XX}`, `<p>`, `@throws`
Example method:
{
"declaring": "Appendable",
"name": "append",
"return": "Appendable",
"javadoc": "Appends a subsequence of the specified character sequence to this...",
"parameters": ["CharSequence", "int", "int" ],
"parameter_names": ["csq", "start", "end"]
}
stu-elastic
added
>enhancement
:Core/Infra/Scripting
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
…ing/jdk-src-parse-01
…ing/jdk-src-parse-01
stu-elastic
commented
Jan 27, 2021
| this.importedMethods = Method.fromInfos( | ||
| info.getImportedMethods(), | ||
| javaNamesToDisplayNames, | ||
| new StdlibJavadocExtractor.ParsedJavaClass() |
There was a problem hiding this comment.
Verify if necessary.
jdconrad
approved these changes
Jan 28, 2021
There was a problem hiding this comment.
LGTM! Thanks for the walkthrough earlier.
A couple of thoughts:
- We chatted briefly about this, but would you please double check that String is correctly inserted for shared API methods, so we don't end up with the same bug our current documentation has.
- I wonder if on the design it would make more sense to collect the jdk info after collecting our whitelist info so that if it's null it doesn't have to be checked for null multiple times.
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/StdlibJavadocExtractor.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/StdlibJavadocExtractor.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/StdlibJavadocExtractor.java
Outdated
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Show resolved
Hide resolved
modules/lang-painless/src/doc/java/org/elasticsearch/painless/PainlessInfoJson.java
Outdated
Show resolved
Hide resolved
stu-elastic
added a commit
to stu-elastic/elasticsearch
that referenced
this pull request
Feb 1, 2021
* Scripting: Parse stdlib files for parameter names
* Task `generateContextApiSpec` takes optional system parameter
`jdksrc` with path to extracted java standard library source
files.
* stdlib source files are the source of `parameter_names` list
and the `javadoc` value.
* javadoc values may contain newlines and markup such as
`{@code XX}`, `<p>`, `@throws`
Example method:
```
{
"declaring": "Appendable",
"name": "append",
"return": "Appendable",
"javadoc": "Appends a subsequence of the specified character sequence to this...",
"parameters": ["CharSequence", "int", "int" ],
"parameter_names": ["csq", "start", "end"]
}
```
stu-elastic
added a commit
that referenced
this pull request
Feb 2, 2021
* Scripting: Parse stdlib files for parameter names (#67837) * Scripting: Parse stdlib files for parameter names * Task `generateContextApiSpec` takes optional system parameter `jdksrc` with path to extracted java standard library source files. * stdlib source files are the source of `parameter_names` list and the `javadoc` value. * javadoc values may contain newlines and markup such as `{@code XX}`, `<p>`, `@throws` Example method: ``` { "declaring": "Appendable", "name": "append", "return": "Appendable", "javadoc": "Appends a subsequence of the specified character sequence to this...", "parameters": ["CharSequence", "int", "int" ], "parameter_names": ["csq", "start", "end"] } ``` Backport: 7c98d9a * Scripting: readable array types for context api (#68237) Instead of fixing up array names post-hoc when generating the api spec and painless context docs, fix them up in the `_scripts/painless/_context` API call. Backport: 460b33f
|
master: 7c98d9a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
jdksrcwith path to extracted java standard library sourcefiles.
parameter_nameslistand the
javadocvalue.{@code XX},<p>,@throwsExample method: