Simplify the split() documentation by removing the join()s from the examples #18676

scottchiefbaker · 2021-04-01T21:35:27Z

split() is a very basic function, and the documentation should be simple for novices to be able to understand. The split() documentation contains a lot of join() in the examples which only serve to muddle the concepts. This replaces the join() in the example with actual output behind a comment block

Grinnz · 2021-04-01T21:44:38Z

This looks much clearer and more consistent to me. One thing I would suggest is maybe leaving out all of the semicolons, since these are just showing the "output" of expressions and not what they'll do as a complete statement (which is nothing, in void context).

pod/perlfunc.pod

split() is a very basic function, and the documentation should be simple for novinces. The split() documentation contains a lot of join() in the examples which only serve to muddle the concepts. This replaces the join() in the example with output in comments

khwilliamson · 2021-04-02T16:44:24Z

pod/perlfunc.pod

+Using split in this fashion is very similar to how
+L<C<qwE<sol>E<sol>>|/qwE<sol>STRINGE<sol>> works.
+
+However, this special treatment can be avoided by specifying


This doesn't sound right. Two adjacent sentences each beginning with

However, this special treatment

Good catch I'll tweak the wording.

…xamples (Perl#18676) * Remove join() from split() examples as it confuses the concepts split() is a very basic function, and the documentation should be simple for novinces. The split() documentation contains a lot of join() in the examples which only serve to muddle the concepts. This replaces the join() in the example with output in comments * Fix a double sentence per KHW

scottchiefbaker force-pushed the split_doc_fixes branch from 0f0cff9 to 66096a8 Compare April 1, 2021 21:39