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

Fix spelling of 'fallback_to_build_date' in logs #26

Merged
merged 1 commit into from
Apr 14, 2020
Merged

Fix spelling of 'fallback_to_build_date' in logs #26

merged 1 commit into from
Apr 14, 2020

Conversation

biochimia
Copy link
Contributor

No description provided.

@timvink timvink merged commit 790a9cc into timvink:master Apr 14, 2020
@timvink
Copy link
Owner

timvink commented Apr 14, 2020

Good catch, thanks for the contribution!

I wouldn't expect these warnings/errors to occur very frequently. Can I ask how you found these, what's your use case?

I'm still not 100% happy with the fallback to build date solution when git is not available. Any thoughts? Was the behaviour at least sufficiently clear?

Will release in the next version, not planned yet..

@biochimia
Copy link
Contributor Author

I bumped into this while setting up the structure for a new mkdocs documentation project. As there were no commits in the project, I expected the plugin to use the fallback and noticed the disconnect between the logged message and your documentation.

In my case, I understood the expected behaviour. We use a custom mkdocs setup internally, and had previously implemented the query from git behaviour with no fallback. When we switched to shallow project clones, we gave up the timestamp.

Browsing our documentation sites, and absent a better freshness measure, I think it's still useful to have the build date available, so some measure of staleness is visible in the pages. It has the downside of not representing the content, on the other hand projects that are alive are also more likely to keep documentation up to date.

One thing I miss is a label to clearly represent the meaning of the date: "Last built on" vs "Last edited on", but this requires more coordination with the theme. One thing to consider is to make a single build date across all pages, but I don't expect that this would be noticeable anywhere 🙂.

@timvink timvink mentioned this pull request Apr 14, 2020
@timvink
Copy link
Owner

timvink commented Apr 14, 2020

Thanks for clarifying!

I agree build_date should be a separate tag, to make things more explicit. I created #28 for this, although I will first work on merging this plugin with another git plugin (see #29).

@biochimia biochimia deleted the patch-2 branch April 14, 2020 13:33
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.

None yet

2 participants