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 yardoc documentation #602

Draft

ellnix wants to merge 1 commit into meilisearch:main from ellnix:yard-doc

Collaborator

ellnix commented Jan 25, 2025

Pull Request

This contains preliminary work on #596 to address the lack of anything more than surface-level documentation on this gem.

Related issue

Fixes #596

How to view documentation

gem install yardoc
yardoc doc
yardoc server
Visit localhost:8808

With live updates:
requires entr

In terminal 1: ls lib/**/*.rb | entr -c yardoc doc
In terminal 2: yardoc server -r

Steps

Wait for input on yardoc documentation #596
Write documentation for other files
Add documentation check to Github actions
Publish documentation


          Document client.rb with yardoc

f570b55

ellnix mentioned this pull request

yardoc documentation #596

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet