sqlalchemy / sqlalchemy/mako

Missing documentation about parameters of render()

Open
#210 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation feature low priority
Dominant language
Python
Stars
459
Forks
90
PR merge metrics
No merged PRs in 30d

Description

Migrated issue, originally created by Anonymous

I'm searching if render can take an "object" like with properties, of a "dict" like with values, or only parameters, and I can't find it in the documentation, I think it's a cool thing to add.

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

Locate the documentation for render() and review how its parameters are currently described. Document whether render() accepts an object with properties, a dict with values, or only positional parameters, and make the supported forms clear to users.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.