Suggestion for modules' web pages: Add a hint to all methods of a certain trait

Open
#529 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
symfony
Domain
documentation

Research direction

Inspect src/Codeception/Module/Symfony/SecurityAssertionsTrait.php and the generated Symfony documentation page at codeception.com/docs/modules/Symfony, especially the dontSeeAuthentication entry. Determine how a trait-wide hint could be represented and propagated; done means the hint is displayed for every method of the trait.

Written by the indexing model from the issue text.

Description

It would be nice to have way to somehow add a hint to some trait (e.g. https://github.com/Codeception/module-symfony/blob/main/src/Codeception/Module/Symfony/SecurityAssertionsTrait.php), and then have this hint displayed at all methods of that trait (e.g. https://codeception.com/docs/modules/Symfony#dontSeeAuthentication).

Background: That security trait requires Symfony's security.helper service to be declared public, see https://github.com/Codeception/module-symfony/issues/138, and there might be more use cases in the future where something has to be explained for an entire trait.

@Naktibalda what do you think?

Dominant language
HTML
Stars
24
Forks
131
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from Codeception/codeception.github.com

All issues in Codeception/codeception.github.com

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.