Undocumented options

[bew]

Here are the list of undocumented options, based on this version of the config: config/src/lib.rs@b6d85f94

• adjust_window_size_when_changing_font_size
• allow_square_glyphs_to_overflow_width Add some missing option doc #462
• automatically_reload_config Add some missing option doc #462
• check_for_updates Add some missing option doc #462
• check_for_updates_interval_seconds Add some missing option doc #462
• daemon_options
• debug_key_events
• enable_csi_u_key_encoding
• experimental_shape_post_processing (won't be documented I guess)
• native_macos_fullscreen_mode
• periodic_stat_logging - internal developer use
• prefer_egl
• ratelimit_mux_line_prefetches_per_second
• resolved_palette - internal cache, not user configurable
• scroll_to_bottom_on_input Add some missing option doc #462
• selection_word_boundary Add some missing option doc #462
• show_tab_index_in_tab_bar
• show_update_window Add some missing option doc #462
• ssh_domains
• swap_backspace_and_delete
• tab_and_split_indices_are_zero_based
• tls_clients
• tls_servers
• use_local_build_for_proxy - internal developer use

---

For the record, here is how I made the list:

1. copy all lines in Config struct (example) in an empty file

2. (vim) Remove all docs with :v/pub/d

3. (vim) Cleanup the lines with :%norm dndwf:D

4. (vim) Sort all options :%sort

5. save file to all_options

6. find missing docs with:

   while read opt; do
     rg $opt docs/config/ > /dev/null || echo $opt
   done <all_options

[bew]

The last one from that list is ratelimit_mux_line_prefetches_per_second just want to note that I have no idea how to document that.

I re-ran the steps to find undocumented options, the only new one is experimental_shape_post_processing which I guess won't be documented, right?

[wez]

Yeah, I think we can close this: I'm likely to change ratelimit_mux_line_prefetches_per_second and I don't expect anyone to need to change that value in the meantime.

[bew]

So be it!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.