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

templates: document how to turn on the new node styles #3517

Closed
wants to merge 1 commit into from

Conversation

ilyagr
Copy link
Collaborator

@ilyagr ilyagr commented Apr 17, 2024

Documents #3501, though only in templates.toml for now (since this is mostly for jj developers to experiment with for now).

Let me know if you prefer that I document this in config.md.

@ilyagr ilyagr marked this pull request as ready for review April 17, 2024 03:28
Documents martinvonz#3501, though
only in `templates.toml` for now (since this is mostly for
jj developers to experiment with for now).

Let me know if you prefer that I document this in config.md.
@ilyagr ilyagr changed the title templates: document how to turn on new node styles templates: document how to turn on the new node styles Apr 17, 2024
@ilyagr ilyagr marked this pull request as draft April 17, 2024 03:36
@ilyagr

This comment was marked as outdated.

@ilyagr ilyagr marked this pull request as ready for review April 17, 2024 03:38
#
# log_node = 'builtin_log_node'
# op_log_node = 'builtin_op_log_node'

Copy link
Collaborator

Choose a reason for hiding this comment

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

I expect the current state is temporary, and the builtin node templates will be enabled in the next release.

Let me know if you prefer that I document this in config.md.

Perhaps, some generalized doc can be added to templates.md? Something like

  • to override the default, set templates.<name> where <name> is usually a command name
  • e.g. templates.log = 'builtin_log_comfortable'
  • stock templates are usually named as builtin_..
  • the list can be obtained by jj log -T (without template value)

Copy link
Collaborator Author

@ilyagr ilyagr Apr 17, 2024

Choose a reason for hiding this comment

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

This sounds like a good idea. I'll look into it if I remember (there are a few other small docs PRs that I might want to wrap up first).

This PR was meant for the short term, but I'm fine with not merging it; it should serve its audience even unmerged as most people who'd care probably look at the list of PRs occasionally.

the list can be obtained by jj log -T (without template value)

That's really nice, good to know!

TODO: This should be documented in jj help log.

@ilyagr
Copy link
Collaborator Author

ilyagr commented Jul 16, 2024

Cc #4095 that will hopefully replace this.

@algmyr
Copy link
Collaborator

algmyr commented Jul 16, 2024

Cc #4095 that will hopefully replace this.

Yep, #4095 is now submitted and this is now obsolete, unless we still want to document these builtins somewhere. Will close this for now, we can re-open if we want some documentation still.

@algmyr algmyr closed this Jul 16, 2024
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