vmware / vmware/singleton

[REQUIREMENT][Ruby] Add Rdoc-compatible documentation to source code

Open
#1,726 0 comments 0 reactions 1 assignee View on GitHub

@Xiaochao8 is already working on this.

Since May 31, 2022.

area/ruby-client kind/feature priority/medium
Dominant language
Java
Stars
72
Forks
69
Avg merge
23h 32m
Merged PRs (30d)
4

Description

Is your feature request related to a problem? Please describe.
Source code documentation

Describe the solution you'd like
Add Rdoc-compatible documentation in source code.

Describe alternatives you've considered
https://ruby.libhunt.com/rdoc-alternatives

Additional context
This is related to https://github.com/vmware/singleton/issues/1725

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.