smarty-php / smarty-php/smarty

implode and explode vs. join and split - no documentation and inconsistencies

Open
#1,174 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
2.3k
Forks
709
PR merge metrics
No merged PRs in 30d

Description

Edit: smarty.net shows up in the Google search results before GitHub. There should be something at the top of all Smarty.net documentation pages that says "Ignore this and see the documentation on Github" with a link to the up to date documentation.

Ignore the rest below. This was my confusion based on the smarty.net website.

The deprecation warning for implode says use join instead.

Similarly the deprecation warning for explode says use split instead.

Documentation is here: https://www.smarty.net/docs/en/language.modifiers.tpl

There is no documentation for split or join.

Could someone add documentation for split and join?

Also, I want to echo this ticket: https://github.com/smarty-php/smarty/issues/1098

In PHP, join and split are aliases for implode and explode, yet they work differently in Smarty. That is counterintuitive. At the minimum that needs to be documented.

Thanks.

Contributor guide

Open the contributing guide

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.

Research direction

Start with the Smarty language modifiers documentation at https://www.smarty.net/docs/en/language.modifiers.tpl and compare it with the up-to-date documentation on GitHub. Done means the split and join behavior and their relationship to implode and explode are documented, and the requested notice links readers from outdated smarty.net pages to GitHub documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.