Fix incorrect function name and description for xdiff_string_rabdiff() #4996
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kamil-tekiela
requested changes
Nov 15, 2025
| <?xml version="1.0" encoding="utf-8"?> | ||
| <!-- $Revision$ --> | ||
| <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> | ||
| <!-- Corrected function signature and description for xdiff_string_rabdiff --> |
Member
There was a problem hiding this comment.
This comments should be deleted.
| <refnamediv> | ||
| <refname>xdiff_string_rabdiff</refname> | ||
| <refpurpose>Make binary diff of two strings using the Rabin's polynomial fingerprinting algorithm</refpurpose> | ||
| <refpurpose>Make a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm</refpurpose> |
Member
There was a problem hiding this comment.
Suggested change
| <refpurpose>Make a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm</refpurpose> | |
| <refpurpose> | |
| Make a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm | |
| </refpurpose> |
| <function>xdiff_file_bpatch</function> for applying patches. | ||
| </para> | ||
| <para> | ||
| This function can be used with both text and binary data. The resulting diff data can later be applied to recreate |
Member
There was a problem hiding this comment.
The projects recommends sticking to 80 character line limit. Could you please split up the long lines?
Comment on lines
+61
to
+62
| Returns a binary diff string containing the differences between the old and new data, or | ||
| <constant>false</constant> if an internal error occurred. |
Member
There was a problem hiding this comment.
Suggested change
| Returns a binary diff string containing the differences between the old and new data, or | |
| <constant>false</constant> if an internal error occurred. | |
| Returns a binary diff string containing the differences between the old and new data,&return.falseforfailure;. |
Comment on lines
+70
to
+73
| <title><function>xdiff_string_rabdiff</function> example</title> | ||
| <para> | ||
| The following example creates a binary diff between two strings and stores it for later patching. | ||
| </para> |
Member
There was a problem hiding this comment.
Could you please merge them together and keep the sentence a bit shorter? E.g. <title>Creation of a binary diff between two strings</title>
Comment on lines
+102
to
+121
| <!-- Keep this comment at the end of the file | ||
| Local variables: | ||
| mode: sgml | ||
| sgml-omittag:t | ||
| sgml-shorttag:t | ||
| sgml-minimize-attributes:nil | ||
| sgml-always-quote-attributes:t | ||
| sgml-indent-step:1 | ||
| sgml-indent-data:t | ||
| indent-tabs-mode:nil | ||
| sgml-parent-document:nil | ||
| sgml-default-dtd-file:"~/.phpdoc/manual.ced" | ||
| sgml-exposed-tags:nil | ||
| sgml-local-catalogs:nil | ||
| sgml-local-ecat-files:nil | ||
| End: | ||
| vim600: syn=xml fen fdm=syntax fdl=2 si | ||
| vim: et tw=78 syn=sgml | ||
| vi: ts=1 sw=1 | ||
| --> |
Member
There was a problem hiding this comment.
Why did you add spaces here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes the
xdiff_string_rabdiff()documentation, which incorrectly displayed the function name and description forxdiff_string_bdiff().Changes:
Issue here #4987