MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-04-18 20:41:22 +07:00
Code Issues Packages Projects Releases Wiki Activity

PY-21883: PR. Show elements from 'Other Parameters' inside 'Parameters' section in Numpy docstrings

Browse Source 
closes https://github.com/JetBrains/intellij-community/pull/2051

GitOrigin-RevId: 2438d1c9fdf8d90fd2c046c8a9a55c07f6683778
This commit is contained in:
davfsa
2022-06-20 12:41:01 +02:00
committed by intellij-monorepo-bot
parent 7e2482b363
commit 680913f146
4 changed files with 67 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
python/python-psi-impl/src/com/jetbrains/python/documentation/docstrings/SectionBasedDocString.java
View File

@@ -54,29 +54,29 @@ public abstract class SectionBasedDocString extends DocStringLineParser implemen
protected static final Map<String, String> SECTION_ALIASES =
ImmutableMap.<String, String>builder()
.put("arguments", PARAMETERS_SECTION)
.put("args", PARAMETERS_SECTION)
.put("parameters", PARAMETERS_SECTION)
.put("keyword args", KEYWORD_ARGUMENTS_SECTION)
.put("keyword arguments", KEYWORD_ARGUMENTS_SECTION)
.put("other parameters", OTHER_PARAMETERS_SECTION)
.put("attributes", ATTRIBUTES_SECTION)
.put("methods", METHODS_SECTION)
.put("note", "notes")
.put("notes", "notes")
.put("example", "examples")
.put("examples", "examples")
.put("return", RETURNS_SECTION)
.put("returns", RETURNS_SECTION)
.put("yield", YIELDS_SECTION)
.put("yields", "yields")
.put("raises", RAISES_SECTION)
.put("references", "references")
.put("see also", "see also")
.put("warning", "warnings")
.put("warns", "warnings")
.put("warnings", "warnings")
.build();
.put("arguments", PARAMETERS_SECTION)
.put("args", PARAMETERS_SECTION)
.put("parameters", PARAMETERS_SECTION)
.put("keyword args", KEYWORD_ARGUMENTS_SECTION)
.put("keyword arguments", KEYWORD_ARGUMENTS_SECTION)
.put("other parameters", OTHER_PARAMETERS_SECTION)
.put("attributes", ATTRIBUTES_SECTION)
.put("methods", METHODS_SECTION)
.put("note", "notes")
.put("notes", "notes")
.put("example", "examples")
.put("examples", "examples")
.put("return", RETURNS_SECTION)
.put("returns", RETURNS_SECTION)
.put("yield", YIELDS_SECTION)
.put("yields", "yields")
.put("raises", RAISES_SECTION)
.put("references", "references")
.put("see also", "see also")
.put("warning", "warnings")
.put("warns", "warnings")
.put("warnings", "warnings")
.build();
private static final Pattern SPHINX_REFERENCE_RE = Pattern.compile("(:\\w+:\\S+:`.+?`|:\\S+:`.+?`|`.+?`)");
public static final Set<String> SECTION_NAMES = SECTION_ALIASES.keySet();
@@ -365,7 +365,11 @@ public abstract class SectionBasedDocString extends DocStringLineParser implemen
@NotNull
public List<Section> getParameterSections() {
return getSectionsWithNormalizedTitle(PARAMETERS_SECTION);
final List<Section> parameters = new ArrayList<>();
parameters.addAll(getSectionsWithNormalizedTitle(PARAMETERS_SECTION));
parameters.addAll(getSectionsWithNormalizedTitle(OTHER_PARAMETERS_SECTION));
parameters.addAll(getSectionsWithNormalizedTitle(KEYWORD_ARGUMENTS_SECTION));
return parameters;
}
@NotNull