jbcoe / jbcoe/clang_cpp_code_model

Allow IPython to display cppmodel objects nicely

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

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Currently ipython does not print useful representations of cppmodel objects when they are evaluated.

This suggests that a fix is simple to implement: http://ipython.org/ipython-doc/dev/api/generated/IPython.lib.pretty.html

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.

Research direction

Start by reading the linked IPython.lib.pretty documentation and inspect how cppmodel objects currently represent themselves. Determine the appropriate pretty-print integration point, then verify that evaluated cppmodel objects display useful representations in IPython.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
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.