Skip to content

Add examples to Sodium base64 functions - #5866

Open
MauricioFauth wants to merge 1 commit into
php:masterfrom
MauricioFauth:sodium-base64-examples
Open

MauricioFauth wants to merge 1 commit into
php:masterfrom
MauricioFauth:sodium-base64-examples

Conversation

@MauricioFauth

Copy link
Copy Markdown
Member
  • sodium_base642bin()
  • sodium_bin2base64()

- sodium_base642bin()
- sodium_bin2base64()
Comment on lines +79 to 81
<member><function>sodium_bin2base64</function></member>
<member><function>chunk_split</function></member>
<member><function>convert_uuencode</function></member>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<member><function>sodium_bin2base64</function></member>
<member><function>chunk_split</function></member>
<member><function>convert_uuencode</function></member>
<member><function>chunk_split</function></member>
<member><function>convert_uuencode</function></member>
<member><function>sodium_bin2base64</function></member>

@jordikroon jordikroon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor style related nits.

</simpara>
</refsect1>

<refsect1 role="examples"><!-- {{{ -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please remove all the comments in this file? <!-- {{{ -->, etc. In the past this was used more often but nowadays we try to avoid it as it makes the XML harder to read.

</simpara>
</refsect1>

<refsect1 role="examples"><!-- {{{ -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as base642bin:

Can you please remove all the comments in this file? , etc. In the past this was used more often but nowadays we try to avoid it as it makes the XML harder to read.


<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<example xml:id="sodium-base642bin.example.basic"><!-- {{{ -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On top of the comment, no need to include xml:id for (all of the) examples.


<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<example xml:id="sodium-bin2base64.example.basic"><!-- {{{ -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On top of the comment, no need to include xml:id for (all of the) examples.

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.

3 participants