Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

documentation: display the implementation when it only has one line

See original GitHub issue

Like in RA.mapIndexed and RA.reduceIndexed, I think it’s can be useful to display the implementation of all one line functions.

Just by adding in documentation :

Implementation: `const mapIndexed = R.addIndex(` 

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:1
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

char0ncommented, Apr 26, 2018

@guillaumearm good idea. But it create the problem of disconnecting when we document and what is the implementation. Can we somehow automate it via jsdoc and our docdash theme ?

char0ncommented, Feb 9, 2020

Closing this for now. The source code of the function is directly accessible from documentation anyway.

Read more comments on GitHub >

github_iconTop Results From Across the Web

5 - Comments
Documentation comments (known as "doc comments") are Java-only, ... Programs can have four styles of implementation comments: block, single-line, trailing, ...
Read more >
c# - Comment the interface, implementation or both?
Implementations are just that, as long as they conform to the interface there is no need to document them separately. Share.
Read more >
How to Write Doc Comments for the Javadoc Tool - Oracle
The first line that begins with an "@" character ends the description. There is only one description block per doc comment; you cannot...
Read more >
Explicit Interface Implementation - C# Programming Guide
A class can implement interfaces that contain a member with the same signature in C#. Explicit implementation creates a class member ...
Read more >
Documenting C++ Code - LSST DM Developer Guide
Multi-line documentation blocks must begin with /** and end in */ . Single-line documentation blocks must begin with /// . For consistency, do...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found