Skip to content

Update README.md#47

Open
lohith1511 wants to merge 1 commit intodrkrillo:mainfrom
lohith1511:patch-1
Open

Update README.md#47
lohith1511 wants to merge 1 commit intodrkrillo:mainfrom
lohith1511:patch-1

Conversation

@lohith1511
Copy link
Copy Markdown

except python, the tables format aligned neatly.

except python, the tables format aligned neatly.
Copy link
Copy Markdown
Owner

@drkrillo drkrillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Problem

You are modifying README.md, which solves the probelm temporaly. Let me explain what I mean:

  1. a githubactions workflow runs every day to re-render README.md
  2. this workflow triggers update_issues.py, which uses README.md.j2 template, inside app/templates/
  3. then, this re-rendered README.md is published in the main entry of the repository.

With your actual solution, the problem will be solved but just for that day's README file. Next day, when update_issues.py is run again by the githubactions workflow, the problem will persist.

Solution

Instead of modifying README.md, which is only a temporal solution, you should solve the problem from the root cause: the template itself, app/templates/README.md.j2.

  1. Inside this file, there is a template to render the tables by programming language.
  2. The problem is in this section:
{% for result in results -%}
### {{result.language}}

| Repo | Title | Comments |
| --- | --- | --- |

{% for issue in result.issues -%}
| {{issue.repo}} | [{{issue.title}}]({{issue.url}}) | {{issue.comments}} |
{% endfor %}
{% endfor %}
  1. The table is not rendering correctly the issues: instead of creating a table for them, is creating a string with the | symbol concatenating them, but not showing them in a table format, which suggests that the formatting for the table is not correct.

That formatting should be solved.

It shouldn't be a big PR, maybe just a line or two of difference.

@drkrillo
Copy link
Copy Markdown
Owner

In case you need guidance to:

  1. running the project locally
  2. creating a github API access token
  3. setting the environment variables so that you have all set up locally to run the project,

Just let me know and we can find a way to talk about it in a more in-depth manner.

Repository owner locked and limited conversation to collaborators Mar 20, 2025
Repository owner unlocked this conversation Mar 20, 2025
@drkrillo
Copy link
Copy Markdown
Owner

drkrillo commented Mar 20, 2025

Are you still working on this? @lohith1511

@lohith1511
Copy link
Copy Markdown
Author

lohith1511 commented Mar 20, 2025 via email

@drkrillo drkrillo closed this Mar 21, 2025
@drkrillo drkrillo mentioned this pull request Mar 21, 2025
@AbiRaja-tech
Copy link
Copy Markdown

@drkrillo @P3st83 Hey I can still see the table is having same issue and would love to resolve it. Please let me know if I can proceed with it.
XD:)

@drkrillo
Copy link
Copy Markdown
Owner

@AbiRaja-tech hi there. Sorry for my delay.

You can try to solve it. The problem is in the template, not the README.

Feel free to try out :)

@drkrillo drkrillo reopened this Sep 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants