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

Fixed incorrect casing in LCLSGeneral.plcproj #80

Merged
merged 1 commit into from
Aug 7, 2023

Conversation

RobertoRoos
Copy link
Contributor

@RobertoRoos RobertoRoos commented Aug 7, 2023

Description

Silly of course: but the names of two files in the PLC project don't match.

On Windows this should almost never be relevant, but I thought maybe you'll accept this fix.

Motivation and Context

I ran into this as I'm using this project as a test target for a Sphinx-PLC integration.

How Has This Been Tested?

Where Has This Been Documented?

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive comments
  • Test suite passes locally
  • Libraries are set to Always Newest version (Library, *)
  • Committed with pre-commit or ran pre-commit run --all-files

@ZLLentz
Copy link
Member

ZLLentz commented Aug 7, 2023

It seems like this happens when someone renames a file manually/outside of TwinCAT (my guess). I notice that each of these xml files has their name tag set to the path picked up here, implying that the path was changed without consulting TwinCAT.

<DUT Name="ST_FbDiagnostics" Id="{07dcfd66-d6ab-4320-bb04-7a16ac42f205}">
<POU Name="FB_TimeStampBuffer" Id="{b2db97ec-7312-4822-a3b4-76ec1968b59f}" SpecialFunc="None">

I think this fix is 👍 and thank you for contributing!

@ZLLentz
Copy link
Member

ZLLentz commented Aug 7, 2023

Do you have any links to your Sphinx-PLC integration work? I'm sure a few of us would be interested. We do a bit of sphinx docs building ourselves.

https://github.com/pcdshub/twincat-docs-template

@ZLLentz ZLLentz merged commit b5080a4 into pcdshub:master Aug 7, 2023
9 checks passed
@RobertoRoos RobertoRoos deleted the bugfix/plcproj branch August 8, 2023 07:49
@RobertoRoos
Copy link
Contributor Author

RobertoRoos commented Aug 8, 2023

Thanks for merging.

Sure, the work-in-progress repo is here: https://github.com/RobertoRoos/sphinx-plc-wip

The goal is to parse in-source documentation (like this, with this) like we can already do with Python, C++, etc.

@klauer
Copy link
Contributor

klauer commented Aug 8, 2023

Neat - looks very similar to my own eternally-WIP blark sphinx domain

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

3 participants