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.

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

encoding: Add missing documentation for all public base32 functions #16998

Merged
merged 1 commit into from
Jan 17, 2023
Merged

encoding: Add missing documentation for all public base32 functions #16998

merged 1 commit into from
Jan 17, 2023

Conversation

nahuakang
Copy link
Contributor

@nahuakang nahuakang commented Jan 16, 2023

Add missing documentation per v missdoc command for #7047:

$ v missdoc vlib/encoding/                                
/home/nahua/projects/v/vlib/encoding/base32/base32.v:27:0:pub fn decode_string_to_string(src string) ?string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:31:0:pub fn decode_to_string(src []u8) ?string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:36:0:pub fn decode(src []u8) ?[]u8 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:41:0:pub fn encode_string_to_string(src string) string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:45:0:pub fn encode_to_string(src []u8) string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:49:0:pub fn encode(src []u8) []u8 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:54:0:pub fn (enc &Encoding) encode_to_string(src []u8) string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:58:0:pub fn (enc &Encoding) encode_string_to_string(src string) string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:62:0:pub fn new_std_encoding() Encoding 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:66:0:pub fn new_std_encoding_with_padding(padding u8) Encoding 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:70:0:pub fn new_encoding(alphabet []u8) Encoding 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:74:0:pub fn new_encoding_with_padding(alphabet []u8, padding_char u8) Encoding 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:190:0:pub fn (enc &Encoding) decode_string(src string) ?[]u8 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:199:0:pub fn (enc &Encoding) decode_string_to_string(src string) ?string 
/home/nahua/projects/v/vlib/encoding/base32/base32.v:204:0:pub fn (enc &Encoding) decode(src []u8) ?[]u8 

The following could be updated to #7047:

  • vlib/encoding/base32/base32.v <- Add this as checked
  • vlib/encoding/binary/binary.v <- Remove this checkbox
  • vlib/encoding/csv/reader.v <- Remove this checkbox
  • vlib/encoding/csv/writer.v <- Remove this checkbox
  • vlib/encoding/utf8/utf8.v <- Remove this checkbox

@spytheman spytheman merged commit 93ee6d1 into vlang:master Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants