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

BACKGROUND in docstring may have some issues #6

Closed
include-yy opened this issue Sep 2, 2023 · 2 comments
Closed

BACKGROUND in docstring may have some issues #6

include-yy opened this issue Sep 2, 2023 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@include-yy
Copy link

Hi, this package is very useful to me and I use it for single-file emacs config with gist.

When I read some docstring in igist.el, I noticed that BACKGROUND appears in igist-list-load-gists, igist-list-request, igist-explore-public-gists and igist-list-starred's docstring, the first, thrid and fourth said that If BACKGROUND is nil, don't show user's buffer., but I think it should be If BACKGROUND is non-nil, don't show buffer. Since in igist-list-request the variable backgroun is used like this:

 (unless background
          (igist-ensure-buffer-visible buffer))))))

Also, BACKGROUND in igist-list-starred's docstring could be deleted, because there is no background arg in arglist.

Regards.

@include-yy include-yy added the bug Something isn't working label Sep 2, 2023
@KarimAziev
Copy link
Owner

KarimAziev commented Sep 3, 2023

@include-yy Thank you for bringing this to our attention. The documentation indeed was inaccurate. I have updated the docstrings in these functions to align with the actual programmatic usage of BACKGROUND . Please feel free to check out the commit that fixes this issue and let me know if you have any other suggestions or comments.

@include-yy
Copy link
Author

I have updated the docstrings in these functions to align with the actual programmatic usage of BACKGROUND .

Thanks! That really makes it clearer, it took me some time to get the idea that some of them were async functions we I saw callback argument at the first time. I think now the docstring is more friendly to whom not familiar with async or callback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants