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.

Sign up for GitHub

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

Jump to bottom

csp.add_graph_output wrong signature suggestion by editor #307

Closed
timkpaine opened this issue Jun 29, 2024 · 4 comments · Fixed by #334
Closed

csp.add_graph_output wrong signature suggestion by editor #307

timkpaine opened this issue Jun 29, 2024 · 4 comments · Fixed by #334
Labels
type: bug Concrete, reproducible bugs

Comments

@timkpaine
Copy link
Member

timkpaine commented Jun 29, 2024 •
edited
Loading

relates to:

Example (VS Code):
Screenshot 2024-06-28 at 20 39 50
@timkpaine timkpaine added the type: bug Concrete, reproducible bugs label Jun 29, 2024
ptomecek added a commit that referenced this issue Jul 15, 2024
@ptomecek
Add signature to adapters so that GNU bash, version 4.4.20(1)-release…
615a020 
… (x86_64-redhat-linux-gnu)

These shell commands are defined internally.  Type `help' to see this list.
Type `help name' to find out more about the function `name'.
Use `info bash' to find out more about the shell in general.
Use `man -k' or `info' to find out more about commands not in this list.

A star (*) next to a name means that the command is disabled.

 job_spec [&]                                                                                                                    history [-c] [-d offset] [n] or history -anrw [filename] or history -ps arg [arg...]
 (( expression ))                                                                                                                if COMMANDS; then COMMANDS; [ elif COMMANDS; then COMMANDS; ]... [ else COMMANDS; ] fi
 . filename [arguments]                                                                                                          jobs [-lnprs] [jobspec ...] or jobs -x command [args]
 :                                                                                                                               kill [-s sigspec | -n signum | -sigspec] pid | jobspec ... or kill -l [sigspec]
 [ arg... ]                                                                                                                      let arg [arg ...]
 [[ expression ]]                                                                                                                local [option] name[=value] ...
 alias [-p] [name[=value] ... ]                                                                                                  logout [n]
 bg [job_spec ...]                                                                                                               mapfile [-d delim] [-n count] [-O origin] [-s count] [-t] [-u fd] [-C callback] [-c quantum] [array]
 bind [-lpsvPSVX] [-m keymap] [-f filename] [-q name] [-u name] [-r keyseq] [-x keyseq:shell-command] [keyseq:readline-functio>  popd [-n] [+N | -N]
 break [n]                                                                                                                       printf [-v var] format [arguments]
 builtin [shell-builtin [arg ...]]                                                                                               pushd [-n] [+N | -N | dir]
 caller [expr]                                                                                                                   pwd [-LP]
 case WORD in [PATTERN [| PATTERN]...) COMMANDS ;;]... esac                                                                      read [-ers] [-a array] [-d delim] [-i text] [-n nchars] [-N nchars] [-p prompt] [-t timeout] [-u fd] [name ...]
 cd [-L|[-P [-e]] [-@]] [dir]                                                                                                    readarray [-n count] [-O origin] [-s count] [-t] [-u fd] [-C callback] [-c quantum] [array]
 command [-pVv] command [arg ...]                                                                                                readonly [-aAf] [name[=value] ...] or readonly -p
 compgen [-abcdefgjksuv] [-o option] [-A action] [-G globpat] [-W wordlist]  [-F function] [-C command] [-X filterpat] [-P pre>  return [n]
 complete [-abcdefgjksuv] [-pr] [-DE] [-o option] [-A action] [-G globpat] [-W wordlist]  [-F function] [-C command] [-X filte>  select NAME [in WORDS ... ;] do COMMANDS; done
 compopt [-o|+o option] [-DE] [name ...]                                                                                         set [-abefhkmnptuvxBCHP] [-o option-name] [--] [arg ...]
 continue [n]                                                                                                                    shift [n]
 coproc [NAME] command [redirections]                                                                                            shopt [-pqsu] [-o] [optname ...]
 declare [-aAfFgilnrtux] [-p] [name[=value] ...]                                                                                 source filename [arguments]
 dirs [-clpv] [+N] [-N]                                                                                                          suspend [-f]
 disown [-h] [-ar] [jobspec ... | pid ...]                                                                                       test [expr]
 echo [-neE] [arg ...]                                                                                                           time [-p] pipeline
 enable [-a] [-dnps] [-f filename] [name ...]                                                                                    times
 eval [arg ...]                                                                                                                  trap [-lp] [[arg] signal_spec ...]
 exec [-cl] [-a name] [command [arguments ...]] [redirection ...]                                                                true
 exit [n]                                                                                                                        type [-afptP] name [name ...]
 export [-fn] [name[=value] ...] or export -p                                                                                    typeset [-aAfFgilnrtux] [-p] name[=value] ...
 false                                                                                                                           ulimit [-SHabcdefiklmnpqrstuvxPT] [limit]
 fc [-e ename] [-lnr] [first] [last] or fc -s [pat=rep] [command]                                                                umask [-p] [-S] [mode]
 fg [job_spec]                                                                                                                   unalias [-a] name [name ...]
 for NAME [in WORDS ... ] ; do COMMANDS; done                                                                                    unset [-f] [-v] [-n] [name ...]
 for (( exp1; exp2; exp3 )); do COMMANDS; done                                                                                   until COMMANDS; do COMMANDS; done
 function name { COMMANDS ; } or name () { COMMANDS ; }                                                                          variables - Names and meanings of some shell variables
 getopts optstring name [arg]                                                                                                    wait [-n] [id ...]
 hash [-lr] [-p pathname] [-dt] [name ...]                                                                                       while COMMANDS; do COMMANDS; done
 help [-dms] [pattern ...]                                                                                                       { COMMANDS ; } works as part of #307

Signed-off-by: Pascal Tomecek <[email protected]>
ptomecek added a commit that referenced this issue Jul 15, 2024
@ptomecek
Add signature to adapters so that help works as expected, part of #307
760097e 
Signed-off-by: Pascal Tomecek <[email protected]>
@timkpaine timkpaine mentioned this issue Jul 15, 2024
Merged
@ptomecek ptomecek linked a pull request Jul 15, 2024 that will close this issue
Add signature to adapters so that help works as expected #334
Merged
@ptomecek
Copy link
Collaborator

I linked the PR to close this issue, but it's worth testing it will actually fix the editor suggestions on VSCode (which I don't use).

@timkpaine
Copy link
Member Author

This doesn't seem to change anything

@ptomecek
Copy link
Collaborator

So the first commit only fixed calling help(csp.add_graph_output). I just added type hint stubs for csp.add_graph_output and csp.const which allows static type checkers (and hence the IDE autocomplete) to pick up the signatures. I tested on PyCharm, please let me know if it works now on VSCode.

timkpaine pushed a commit that referenced this issue Jul 16, 2024
@ptomecek @timkpaine
Add signature to adapters so that help works as expected, part of #307
7c01d7b 
Signed-off-by: Pascal Tomecek <[email protected]>
timkpaine pushed a commit that referenced this issue Jul 16, 2024
@ptomecek @timkpaine
Add signature to adapters so that help works as expected, part of #307
c8fd883 
Signed-off-by: Pascal Tomecek <[email protected]>
@timkpaine
Copy link
Member Author

nice! clever with the stub
Screenshot 2024-07-16 at 15 03 28

timkpaine pushed a commit that referenced this issue Jul 16, 2024
@ptomecek @timkpaine
Add signature to adapters so that help works as expected, part of #307
3b7cb63 
Signed-off-by: Pascal Tomecek <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: bug Concrete, reproducible bugs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add signature to adapters so that help works as expected Point72/csp
2 participants
@timkpaine @ptomecek