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.

Sign up for GitHub

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

Jump to bottom

Add specifications and EDoc comments to exported functions #78

Open
19 of 43 tasks
Tronso opened this issue Oct 6, 2020 · 1 comment
Open
19 of 43 tasks

Add specifications and EDoc comments to exported functions #78

Tronso opened this issue Oct 6, 2020 · 1 comment
Labels
Community documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Tronso
Copy link
Collaborator

Tronso commented Oct 6, 2020 •
edited by albsch
Loading

There are many exported functions in riak_core_lite without function specifications or EDoc comments. Some functions are commented on but the comments are missing the edoc tags. According to the edoc documentation it is also preferable to use the standard Erlang -spec specifications instead of the EDoc @spec comments, which can be found in the code.

Checklist of modules to track progress:

  • chash.erl
  • chashbin.erl
  • gen_nb_server.erl
  • riak_core.app.src
  • riak_core.erl
  • riak_core_apl.erl
  • riak_core_app.erl
  • riak_core_claim.erl
  • riak_core_claimant.erl
  • riak_core_claim_util.erl
  • riak_core_eventhandler_guard.erl
  • riak_core_eventhandler_sup.erl
  • riak_core_gossip.erl
  • riak_core_handoff_listener.erl
  • riak_core_handoff_listener_sup.erl
  • riak_core_handoff_manager.erl
  • riak_core_handoff_receiver.erl
  • riak_core_handoff_receiver_sup.erl
  • riak_core_handoff_sender.erl
  • riak_core_handoff_sender_sup.erl
  • riak_core_handoff_sup.erl
  • riak_core_node_watcher.erl
  • riak_core_node_watcher_events.erl
  • riak_core_priority_queue.erl
  • riak_core_ring.erl
  • riak_core_ring_events.erl
  • riak_core_ring_handler.erl
  • riak_core_ring_manager.erl
  • riak_core_ring_util.erl
  • riak_core_send_msg.erl
  • riak_core_status.erl
  • riak_core_sup.erl
  • riak_core_test_util.erl
  • riak_core_util.erl
  • riak_core_vnode.erl
  • riak_core_vnode_manager.erl
  • riak_core_vnode_master.erl
  • riak_core_vnode_proxy.erl
  • riak_core_vnode_proxy_sup.erl
  • riak_core_vnode_sup.erl
  • riak_core_vnode_worker.erl
  • riak_core_vnode_worker_pool.erl
  • vclock.erl
@Tronso Tronso added the documentation Improvements or additions to documentation label Oct 6, 2020
Tronso pushed a commit that referenced this issue Oct 6, 2020
Added some specs and documentation to riak_core_ring (see #78)
6c04c04
@Tronso
Copy link
Collaborator Author

Tronso commented Oct 6, 2020

To prevent errors in the specification blocking the master pipeline the issue is handled on branch 78_documentation.

@Tronso Tronso mentioned this issue Oct 9, 2020
Merged
albsch pushed a commit that referenced this issue Nov 24, 2020
@albsch
Added some specs and documentation to riak_core_ring (see #78)
a66dac4
albsch pushed a commit that referenced this issue Jul 13, 2021
Added some specs and documentation to riak_core_ring (see #78)
0af12e9
albsch pushed a commit that referenced this issue Jul 13, 2021
Added some specs and documentation to riak_core_ring (see #78)
a0644ca
albsch pushed a commit that referenced this issue Jul 13, 2021
Added some specs and documentation to riak_core_ring (see #78)
61d25bd
albsch pushed a commit that referenced this issue Jul 13, 2021
Ignore VSCode sttings
61561b3 
Added specs and documentation to riak_core_claim
+ format

Added some specs and documentation to riak_core_ring (see #78)

Added specs and documentation to riak_core_apl

Added tags to chashbin documentation

Added specs and documentation to riak_core_apl
fixed typo in doc tag in chashbin

Added documentation status: done to reviewed files

Added specs and documentation to riak_core_app

Added documentation status: done to riak_core_app

Added specs and documentation to riak_core

Added specs and documentation to riak_core_claimant

Fixed typo in atom in spec

Added some specs and documentation to riak_core_ring_manager while

Added documentation to riak_core_handoff_listener_sup

Added specs to all handoff supervisors

Added documentation to riak_core_handoff_listener

Added documentation to riak_core_handoff_manager

Documentation for riak_core_handoff_receiver

Added documentation to riak_core_handoff_sender

Added draw.io project cotaining action diagrams of some core functionalities.

Apply suggestions from code review

Removed status of documentation from source files
albsch pushed a commit that referenced this issue Jul 13, 2021
Ignore VSCode sttings
7559873 
Added specs and documentation to riak_core_claim
+ format

Added some specs and documentation to riak_core_ring (see #78)

Added specs and documentation to riak_core_apl

Added tags to chashbin documentation

Added specs and documentation to riak_core_apl
fixed typo in doc tag in chashbin

Added documentation status: done to reviewed files

Added specs and documentation to riak_core_app

Added documentation status: done to riak_core_app

Added specs and documentation to riak_core

Added specs and documentation to riak_core_claimant

Fixed typo in atom in spec

Added some specs and documentation to riak_core_ring_manager while

Added documentation to riak_core_handoff_listener_sup

Added specs to all handoff supervisors

Added documentation to riak_core_handoff_listener

Added documentation to riak_core_handoff_manager

Documentation for riak_core_handoff_receiver

Added documentation to riak_core_handoff_sender

Added draw.io project cotaining action diagrams of some core functionalities.

Apply suggestions from code review

Removed status of documentation from source files
albsch added a commit that referenced this issue Jul 13, 2021
@albsch
Github Actions Workflow (#81)
3244ef3 
* Added pipeline
* Workflow badge

Ignore VSCode sttings

Added specs and documentation to riak_core_claim
+ format

Added some specs and documentation to riak_core_ring (see #78)

Added specs and documentation to riak_core_apl

Added tags to chashbin documentation

Added specs and documentation to riak_core_apl
fixed typo in doc tag in chashbin

Added documentation status: done to reviewed files

Added specs and documentation to riak_core_app

Added documentation status: done to riak_core_app

Added specs and documentation to riak_core

Added specs and documentation to riak_core_claimant

Fixed typo in atom in spec

Added some specs and documentation to riak_core_ring_manager while

Added documentation to riak_core_handoff_listener_sup

Added specs to all handoff supervisors

Added documentation to riak_core_handoff_listener

Added documentation to riak_core_handoff_manager

Documentation for riak_core_handoff_receiver

Added documentation to riak_core_handoff_sender

Added draw.io project cotaining action diagrams of some core functionalities.

Apply suggestions from code review

Removed status of documentation from source files
albsch added a commit that referenced this issue Jul 13, 2021
@albsch
V0.10.2 (#97)
5c6b82d 
* Github Actions Workflow (#81)
* Added some specs and documentation to riak_core_ring (see #78)
* Fix elvis problems (#83)
* Erlang 24 support (#87)
* Fixed fresh function (#89)
* Bump v0.10.2

Co-authored-by: woelki <[email protected]>
@albsch albsch added Community good first issue Good for newcomers help wanted Extra attention is needed labels Jul 14, 2021
albsch added a commit that referenced this issue Mar 21, 2022
@albsch
V0.10.2 (#97)
5948565 
* Github Actions Workflow (#81)
* Added some specs and documentation to riak_core_ring (see #78)
* Fix elvis problems (#83)
* Erlang 24 support (#87)
* Fixed fresh function (#89)
* Bump v0.10.2

Co-authored-by: woelki <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Community documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@albsch @Tronso