phpDocumentor / phpDocumentor/guides

Deprecated use of string values for inline compound nodes

Open
#1,161 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

deprecation
Dominant language
PHP
Stars
36
Forks
22
Avg merge
2d 2h
Merged PRs (30d)
24

Description

Feature request

Inline nodes extending InlineCompoundNode should not be accessed via getValue but getChildren should be used in the templates.

    {%- for child in node.children -%}
        {{- renderNode(child) -}}
    {%- endfor -%}

We will remove the backward compatibility layer in version 2.

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

Search the templates and inline compound-node handling for uses of getValue on InlineCompoundNode instances, then read the surrounding getChildren and renderNode flow. Done means the affected templates use child nodes for rendering and no deprecated string-value access remains; verify with the repository's available checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.