Bugfix or docfix: README.md documentation incorrect or script.Assembly property needs to be changed from protected level to public

Open
#23 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
compilers, documentation

Research direction

Start with the README.md section "Compiling and Executing Entire Classes" and locate the definition of CSharpScriptExecutionAssembly and its Assembly property. Determine whether the example or the property's accessibility is incorrect, then validate that the documented script.Assembly usage is either corrected or made usable without breaking the intended protection level.

Written by the indexing model from the issue text.

Description

In README.md, the example provided in the section "Compiling and Executing Entire Classes" notes to use the following if you need access to the assembly:

var assembly = script.Assembly

This does not work as an CS0122 error is thrown stating "'CSharpScriptExecutionAssembly' is inaccessible due to its protection level."

I would submit a PR to change from protected to public, but was not sure if there was a specific reason for it to be designated as protected.

Dominant language
C#
Stars
256
Forks
47
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RickStrahl/Westwind.Scripting

All issues in RickStrahl/Westwind.Scripting

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.