Trigger docstr generation via keybind (avoid doom conflict)

[innerout]

Hi, jcs thanks for the great plugin! I am trying to use your plugin with a doom-emacs configuration but doom conflicts with docstr. Whenever I press enter at the docstring position, doom intercepts the keypress and inserts a new comment. (However, in my vanilla config, docstr works as expected.) It would be helpful to have a way to trigger the docstr action via key bind and auto insert a proper comment based on the marker's position.

[jcs090218]

Thanks for reporting this issue to us! :) I don't use doom-emacs so my opinions may be a bit limited. 😖

I don't think it will resolve the issue even it was triggered via key since the function would just indent the whole document region after the insertion (depends on the language). What language does not work well for you? all of them?

[innerout]

I am using C/C++.

[innerout]

Hi jcs, is there a way to find which advice or function from the doom config interferes with docstr's functionality somehow?

[jcs090218]

The commands and keys (alist) can be customized with variable docstr-trigger-alist :

docstr/docstr.el

Lines 197 to 206 in 5ae8047

	(defcustom docstr-trigger-alist
	`(("/" . docstr-trigger-csharp)
	("/" . docstr-trigger-golang)
	("-" . docstr-trigger-lua)
	("RET" . docstr-trigger-lua-return)
	("\"" . docstr-trigger-python)
	("#" . docstr-trigger-ruby)
	("/" . docstr-trigger-rust)
	("/" . docstr-trigger-swift))
	"List of trigger to each `major-mode'.

Hope the info helps!

[innerout]

Thank you for the info! Why C/C++ are omitted from the list?

[jcs090218]

C/C++ is in the special case, it currently binds to docstr--trigger-return

Add in docstr--enable:

docstr/docstr.el

Line 226 in 5ae8047

(docstr-util-key-advice-add "RET" :after #'docstr--trigger-return)

[innerout]

Is there a way to avoid the return trigger and trigger it with a special symbol, e.g., with / as in csharp?.

[jcs090218]

There wasn't a way to do this. But I have opened up a PR in #24.

After this, you should able to customize docstr-trigger-alist to avoid such an action. :)

[innerout]

Thanks for your work, I have tried changing RET to rarely used characters such as @ to trigger docstr, but it still does not work with doom.

[innerout]

So I found the bug after three weeks of debugging! When using doom emacs, the return key is bound to a function that guesses what to do based on the context (based on a brief search and my intuition). I am not sure what it exactly does, but it does not enter a newline. So to make this plugin work, you have to call evil-ret, which inserts an actual newline, and the plugin successfully works then.

For future doom users, the only thing I have in my configuration for docstr to work is the snippet below:

(setq docstr-c-style 'javadoc)
(setq docstr-key-support t)

@jcs090218 Thanks for your time and effort!

[flyingicedragon]

Docstr can't trigger when I use Python either. Docstr uses "\"" to trigger in Python. It didn't work before and after I disabled smartparens-mode.

[innerout]

Docstr can't trigger when I use Python either. Docstr uses "\"" to trigger in Python. It didn't work before and after I disabled smartparens-mode.

I suggest opening another issue, as the repo contains PRs and issues that mention problems with smartparens.