search

AlchemyCMS / alchemy_cms

Alchemy is the Open Source Rails CMS framework for the component based web that can be used as classic server side rendered or headless CMS.
https://www.alchemy-cms.com
BSD 3-Clause "New" or "Revised" License
839 stars 315 forks source link

Should resources display updated_at by default? #3023

Closed HatsuMora closed 2 weeks ago

HatsuMora commented 4 weeks ago

Steps to reproduce

According to the documentation on this file (lib/alchemy/resource.rb:27), the attribute 'updated_at' should be excluded by default for all resources, however it is not included on the DEFAULT_SKIPPED_ATTRIBUTES.

I created a naive PR thinking it was a minor error later to found that the unit test is expecting 'updated_at' to be render.

I can create a PR again (with the unit test fixed) if this is the correct expectation. Otherwise I can fix the comment in the code to align it with what it is actually happening.

Expected behavior

Code and documentation should match.

Actual behavior

They contradict each other.

System configuration

tvdeyen commented 4 weeks ago

Thanks. I think the documentation is outdated.

HatsuMora commented 2 weeks ago

Should I send the PR or close the issue?

tvdeyen commented 2 weeks ago

If you don't mind it would be appreciated if you would send a PR to the guides.