Skip to content

Add example initializer to be copied to projects#44

Merged
glensc merged 6 commits intomasterfrom
autoload-example
Oct 24, 2020
Merged

Add example initializer to be copied to projects#44
glensc merged 6 commits intomasterfrom
autoload-example

Conversation

@glensc
Copy link
Copy Markdown
Contributor

@glensc glensc commented Oct 13, 2020

Perhaps we still need some file to be added to auto_prepend_file config.

Fixes: #42

@glensc glensc requested a review from a team October 13, 2020 08:15
@glensc glensc self-assigned this Oct 13, 2020
@glensc
Copy link
Copy Markdown
Contributor Author

glensc commented Oct 13, 2020

@perftools/maintainers: Should this example file be complete with all configuration options? or should this file be minimal and pointing to documentation?

a fine balance between maintainability (duplication) and usability for the end-users.

In other words, should we but more effort into having good defaults, or rather have it copied out every bit that can be configured.

@markstory
Copy link
Copy Markdown
Member

Should this example file be complete with all configuration options? or should this file be minimal and pointing to documentation?

I would do all configuration and include the documentation in the example file. Then the docs could link to the current source file.

@glensc
Copy link
Copy Markdown
Contributor Author

glensc commented Oct 13, 2020

There's also defaults in the source itself:

@glensc
Copy link
Copy Markdown
Contributor Author

glensc commented Oct 22, 2020

Updated, something like this then?

@glensc
Copy link
Copy Markdown
Contributor Author

glensc commented Oct 23, 2020

There's still duplication in readme file, becase moving them to one big file made imho it unreadable

@glensc glensc marked this pull request as ready for review October 23, 2020 02:34
@glensc glensc merged commit 0f643c9 into master Oct 24, 2020
@glensc glensc deleted the autoload-example branch October 24, 2020 08:41
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.

Why does the project not support non intrusive mode?

2 participants