summaryrefslogtreecommitdiff
path: root/elisp/geiser-autodoc.el
AgeCommit message (Collapse)Author
2024-07-06Cleanup library headersJonas Bernoulli
- In the summary line, use three dashes to separate the file name from the summary. That is the convention, which some tools depend on, and for some libraries we already did it here too. - Capitalize the first word in the summary. That is the convention, and for some libraries we already did it here too. - For libraries that have a commentary, make sure it is placed in a "Commentary:" section. - Make sure the "Code:" heading, which separates the header from the code part of the library, exists in all files.
2023-07-14Fix typosJonas Bernoulli
2022-12-05Take the byte-compilers advice into accountJonas Bernoulli
2022-10-21more tweaks to regexp signature findingjao
and its use in autodoc (for instance, skip it when in the REPL).
2022-10-16fix for autodoc, ahem, extensionjao
2022-10-16fallback autodoc inferred via cheap regexpsjao
same code that finds putative definitions, with all its caveats
2022-10-13autodoc: correctly display docsigs for in-region completions (#56)jao
we were doing it really wrong: first, by not setting the evaluation environment when things are computed outside the original buffer (the completion in region case for consult and the likes, where the current buffer is the minibuffer) and, to add insult to injury, by not waiting for a response from the scheme side! actually waiting can make things a tad laggy when the scheme is not as fast as, say, chez and there are lots of completions (if one uses completion-in-region; for pop ups like company it's fine), so i've also added a flag, geiser-autodoc-use-docsig, to turn the functionality off.
2022-09-17Fix for autodoc in geiser-capf--company-docsig and beyondjao
Thanks to Panagiotis Vlantis, see issue #54
2022-04-23Byte-compilation warnings fixedjao
And, actually, fixing bugs: the warnings weren't spurious.
2022-04-10autodoc: make do without dependending on elpa's eldocjao
Playing the trick of checking for eldoc-documentation-functions to know wheter we're at a new enough version, and (hopefully) falling back to the old implementation otherwise.
2022-04-10autodoc: new-style eldoc interfacejao
We remove by-now obsolete usage of eldoc, and depend on the elpa package to ensure backwards compatibility.
2021-12-03Fix: more careful display of signaturesjao
In some cases, Guile cannot figure out a signature and it comes back as #f (:t in emacs-land), rather than a list.
2021-04-21Use defvar-localJonas Bernoulli
It is available since Emacs 24.3 and we already depend on Emacs 24.4.
2020-03-27Fix indentationJonas Bernoulli
2020-03-27Mark the beginning of code part of elisp libraries with Code: headingJonas Bernoulli
It's the convention and by following it we make a big step towards supporting outline navigation. The convention doesn't say much about what parts of the code are supposed to be part of that sections and what parts belong in a subsequent section. Here we put the `require' forms in this section and maybe some setup code, that's a popular approach. In most cases there was " " where we now insert "Code:". They both serve a similar purpose and we keep the former because some users depend on that for navigation. We even add this " " in libraries where it previously was missing. In some cases the permission statement was followed by a commentary, which obviously does not belong in the "Code:" section. In such cases add the conventional "Commentary:" section.
2020-03-27Begin the summary lines of all elisp libraries with three semicolonsJonas Bernoulli
It's the convention and by following it we make a big step towards supporting outline navigation.
2016-08-24Making autodoc failures silentJose Antonio Ortega Ruiz
As requested in github issue #173. Seems it's confusing people, which is exactly the problem it was originally trying to avoid!
2015-03-04Using font-lock-variable-name-face in lieu of bold for autodocJose Antonio Ortega Ruiz
For some X faces, a bold string in the modeline causes emacs to widen it to two lines, which is kind of annoying. The default value of font-lock-variable-name-face on color/X displays doesn't include any boldness, and will probably improve the default experience of new users. Thanks to Mario Domenech Goulart for noticing this and the previous one!
2012-10-11WhitespaceJose Antonio Ortega Ruiz
2011-06-23Irrelevant compilation warning fixjao
Using called-interactively-p instead of interactive-p, if you have to know. The latter is deprecated as of Emacs 23.2, which the lowest version supported by Geiser.
2011-06-23Avoid (read) breakage (fixes #33090)jao
Autodoc was firing while the REPL was waiting for input of a (read) call, causing all kinds of misbehaviour. We now inhibit autodoc on sending a form for evaluation and re-inhibit it once a prompt is read back again.
2011-01-09Autodoc mode (de)activation fix.Jose Antonio Ortega Ruiz
Quoth Mark: When the Geiser minor mode is toggled off using the command `geiser-mode', the message: Toggling eldoc-mode off; better pass an explicit argument. is displayed in the echo area. This is traceable to line 219: (eldoc-mode geiser-autodoc-mode) The function `eldoc-mode' takes numeric arguments, while `geiser-autodoc-mode' returns boolean values. Here is a simple patch: (eldoc-mode (if geiser-autodoc-mode 1 -1))
2010-12-30New command: "manual" autodoc (C-c C-d s)Jose Antonio Ortega Ruiz
2010-12-30Autodoc nitJose Antonio Ortega Ruiz
2010-12-28Leaner autodoc cacheJose Antonio Ortega Ruiz
We cannot consistently maintain a local cache, because of re-evaluations of external symbols will go unnoticed. The new strategy (remembering only the latest signatures) mostly works, although it introduces a bit of extra flickering every now and then. A global cache is perhaps worth considering.
2010-12-28Less noisy autodoc mode activationJose Antonio Ortega Ruiz
Only display an activation message when called interactively.
2010-12-28Finer grained maintenance of autodoc's cacheJose Antonio Ortega Ruiz
2010-12-28Avoiding autodoc interfering with an active minibufferJose Antonio Ortega Ruiz
A piece of eldoc advice shamelessly lifted from slime.
2010-12-28Wee refactoringJose Antonio Ortega Ruiz
2010-12-28First stab at asynchronous autodoc retrievalJose Antonio Ortega Ruiz
2010-11-28Autodoc's argument display fixedJose Antonio Ortega Ruiz
It was relying on symbol equality, and not dealing correctly with keyword arguments in this new external world. In the process, some cleanups to the scheme data display code.
2010-11-27No more interning in the scheme readerJose Antonio Ortega Ruiz
We avoid using elisp's read for symbols, reading uninterned ones instead. And then, we cannot use symbols as keys in responses from scheme: we're using strings instead.
2010-11-26Autodoc not interning symbolsJose Antonio Ortega Ruiz
We avoid calling symbol-at-point, and keep the cached signatures with strings as keys.
2010-11-26Doc browser: better link highlightingJose Antonio Ortega Ruiz
We were adding extra spaces to function signatures.
2010-11-21CLisms removedJose Antonio Ortega Ruiz
2010-11-21Did i mention that getting autodoc right is hard?Jose Antonio Ortega Ruiz
2010-11-21Correct display of "..." in autodocJose Antonio Ortega Ruiz
It'd be interesting to check what percentage of commits are related to autodoc...
2010-11-21Even better, as in 'correct', display of autodoc argsJose Antonio Ortega Ruiz
We're being a bit silly here, first converting the autodoc retort string to an elisp value and then reconverting the arguments again to a string with scheme syntax. We should probably do this at geiser-syntax's parser level, with a special mode producing stringy representations of tokens. Don't tell anyone.
2010-11-19Better argument display in autodocJose Antonio Ortega Ruiz
Simpler (we don't need no square brackets) and more correct (keywords display as keywords and we only include default values when available (Guile, i'm looking at you).
2010-10-30Elisp: more flexible parsing of :eval and :ge formsJose Antonio Ortega Ruiz
This allows the implementation decide the concrete structure of the code sent to the REPL. For instance, it doesn't need to be a single s-expression, and argument order can be re-arranged.
2010-10-06Use cl only at compile timeJose Antonio Ortega Ruiz
2010-09-06Autodoc: clean cache upon evaluationJose Antonio Ortega Ruiz
2010-08-11Fixed bug in autodoc signature recognition.Jose Antonio Ortega Ruiz
2010-08-07geiser-font-lock-autodoc-procedure-name -> geiser-font-lock-autodoc-identifierJose Antonio Ortega Ruiz
2010-08-07geiser-autodoc-procedure-name-format -> geiser-autodoc-identifier-formatJose Antonio Ortega Ruiz
2010-07-28Displaying variable values in autodoc.Jose Antonio Ortega Ruiz
2010-06-06Elisp: better fix for previous bug.Jose Antonio Ortega Ruiz
2010-06-06Elisp: fixes for key args display.Jose Antonio Ortega Ruiz
2010-06-06Avoiding duplicates in autodoc arg listsJose Antonio Ortega Ruiz
2010-06-05Better signature parsing (improper arg lists).Jose Antonio Ortega Ruiz