Variable Length Quantity could do with a more detailed example table

Open
#2,027 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Locate the exercise page's VLQ example table in the shared exercise metadata; the issue does not name a file or test. Compare the existing hexadecimal-only table with the Wikipedia example, then update the table and verify that the requested binary columns and bit emphasis are represented.

Written by the indexing model from the issue text.

Description

I think the example table with only hexadecimal input and output values can be a little confusing.

On the wikipedia VLQ page, the array details the binary input, the binary output and the hexadecimal output to make the conversion clearer.

Shouldn't the exercise page also specify these steps?
I would suggest adding columns to the table and putting them in the following order:

hexadecimal input | binary input | binary output | hexadecimal output

and emphasize the n°7 bit of each output byte (which is set to 0 in the last byte and set to 1 in the preceding bytes) by making it bold.

Dominant language
Ruby
Stars
362
Forks
566
Avg merge
15h 13m
Merged PRs (30d)
8

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from exercism/problem-specifications

All issues in exercism/problem-specifications

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.