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 doc for --self flag #139

Closed

Conversation

alicederyn
Copy link
Contributor

@alicederyn alicederyn commented Aug 22, 2023

The docs for pystack remote --self appear to have been missed off the README, though the --self flag is shown in the usage string. Copy/pasted from the output of pystack remote --help

Signed-off-by: Alice <Alice.Purcell.39@gmail.com>
@alicederyn
Copy link
Contributor Author

I tried to open an issue but none of the templates made any sense for a docs issue.

@godlygeek
Copy link
Contributor

godlygeek commented Aug 22, 2023

I think we should probably just remove this flag. It isn't exercised by our tests, and it appears to have bit rotted:

$ pystack --self
usage: pystack [-h] [-v] [--no-color] {remote,core} ...
pystack: error: the following arguments are required: command
$ pystack --self remote
usage: pystack remote [-h] [-v] [--no-color] [--no-block] [--native] [--native-all] [--locals] [--exhaustive] [--self] pid
pystack remote: error: the following arguments are required: pid

I think we removed the code for handling this flag at some point, and missed removing the flag itself.

@alicederyn Would you be interested in updating the PR to remove all mentions of --self instead?

@alicederyn alicederyn mentioned this pull request Aug 23, 2023
@alicederyn
Copy link
Contributor Author

Closing in favour of #141.

@alicederyn alicederyn closed this Aug 23, 2023
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