Skip to content

Comments on augur_data models are very long #212

Closed

Description

@collectoss-issue-migrator

Note

Migrated from augurlabs/augur#3684
Originally opened by @MoralCode on 2026-02-12


when searching for api.github.com in the codebase, i found a lot of instances of this url in the augur_data.py database models file.

these seem to appear in comments as essentially sample data.

This seems very unnecessary, especially since these comments note we dont store all of that data.

Its making some lines get very close to 10k characters long.

Activity

  1. collectoss-issue-migrator commented on Apr 30, 2026

    @collectoss-issue-migrator
    Author

    Note

    Migrated comment from original
    Originally posted by @KH-Coder865 on 2026-02-13


    So should I remove the unnecessary comments ?

  2. added
    documentationImprovements or additions to documentation
    databaseRelated to the unifed data model/schema
    tech debtTechnical Debt AKA symptoms of past shortcuts that now need to be corrected
    on Apr 30, 2026
  3. collectoss-issue-migrator commented on Apr 30, 2026

    @collectoss-issue-migrator
    Author

    Note

    Migrated comment from original
    Originally posted by @MoralCode on 2026-02-13


    another issue may be better to tackle.

    this is very low priority/isnt really causing issues, probably needs another maintainers input to make sure this is a good path, and also will probably require performing a database migration (meaning it may be stuck behind other PRs in a queue for a bit)

  4. collectoss-issue-migrator commented on Apr 30, 2026

    @collectoss-issue-migrator
    Author

    Note

    Migrated comment from original
    Originally posted by @sgoggins on 2026-02-13


    Is this about the comments on table columns in schema creation?

  5. collectoss-issue-migrator commented on Apr 30, 2026

    @collectoss-issue-migrator
    Author

    Note

    Migrated comment from original
    Originally posted by @MoralCode on 2026-02-13


    yes and no, it is about the comments metadata in the schema, but the main issue is more that they are very long in the source file and maybe dont need a full set of sample data.

    IMO it may be better to have them link to a readthedocs page or something like that where we can keep it more up to date without needing to issue migrations (i assume)

  6. MoralCode commented on May 5, 2026

    @MoralCode
    Contributor

    Resolved by #2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    databaseRelated to the unifed data model/schemadocumentationImprovements or additions to documentationtech debtTechnical Debt AKA symptoms of past shortcuts that now need to be corrected

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions