Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enums doc page is wrong when only using the amber preset #467

Open
benjie opened this issue Aug 11, 2023 · 0 comments
Open

Enums doc page is wrong when only using the amber preset #467

benjie opened this issue Aug 11, 2023 · 0 comments

Comments

@benjie
Copy link
Member

benjie commented Aug 11, 2023

@enum smart comment not enough on its own.

Context: https://discord.com/channels/489127045289476126/498852330754801666/1139285394274402335

Reported by @sgrove

Reproduction SQL:

CREATE TABLE chain_trace_status (
    status TEXT PRIMARY KEY,
    description TEXT
);
COMMENT ON TABLE chain_trace_status IS E'@enum\n@enumName ChainTraceStatus';

INSERT INTO chain_trace_status (status, description) VALUES
    ('PENDING', 'Chain trace is pending'),
    ('IN_PROGRESS', 'Chain trace is in progress'),
    ('SUCCESS', 'Chain trace has finished successfully'),
    ('ERROR', 'Chain trace has finished with errors');

CREATE TABLE chain_trace (
    id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
    chain_id UUID REFERENCES chain(id) ON DELETE CASCADE,
    status TEXT NOT NULL REFERENCES chain_trace_status(status) ON DELETE RESTRICT
);

I thought that issuing this:

COMMENT ON TABLE chain_trace_status IS E'@behavior enum\n@enumName ChainTraceStatus';

should fix it; but apparently it doesn't.

@benjie benjie added this to the V5 RC milestone Aug 11, 2023
@benjie benjie added this to V5.0.0 Oct 4, 2023
@github-project-automation github-project-automation bot moved this to 🌳 Triage in V5.0.0 Oct 4, 2023
@benjie benjie moved this from 🌳 Triage to 🐭 Shrew in V5.0.0 Oct 4, 2023
@benjie benjie moved this from 🐭 Shrew to 📝 Docs Improvements in V5.0.0 May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 📝 Docs Improvements
Development

No branches or pull requests

1 participant